typestrong / tspms Goto Github PK

Subtask of #1

@fdecampredon can you review this file. We can add it to this project directly for now instead of creating a seperate npm dependency (we can move it out once it stabilizes).

In particular the API does two nice things:

1. It supports fileGlob which if present expands the files inplace : code
2. it extends the files to include referenceed and imported files : code

• Integration with code coverage tools
• Integration with travis-ci
• integration with tslint
• externalize the concat-declarations tools ?
• integration with tsconfig
• investigate interface pertinence over atom-typescript
• Contributing.md
• Examples
• Project pages ?

Specifically how do you get createLanguageService (https://github.com/TypeStrong/typescript-project-services/blob/186c4bec51c72d7238919137e04ecb605abe3d9f/src/main/project.ts#L473-L474) to execute in a non UI thread. @fdecampredon I suspect its handled by brackets and the code is not in this project. But I might be wrong.

Alternatively you might be calling createLanguageService with a language service host that doesn't have getScriptFileNames populated and then populating them lazily.

Ok now that the project is a little stable I would like to create a little roadmap.

Name

I quite hate the name that I have given to this project, if anybody has a better idea ... :D

Build system

• I don't know why I have gone with Make, but it's a bit boring and the project would seriously benefit from a better build system. (grunt + grunt-ts ? )
• the script generating the declaration file is interesting perhaps should we extract it in a separate project ?
• Integration with a travis-ci or something like that could be a big bonus

Promise

Actually I have hidden the dependency over 'bluebird' (see : https://github.com/TypeStrong/typescript-project-services/blob/master/src/main/project.ts#L20-L21) to avoid forcing people consuming this project to have a bluebird declaration file, however in fact it would be better to let people inject the promise library they are comfortable with.

Documentation

The project need a read me a description and any kind of documentation helping to consume this project.

Feature

Actually the project expose 4 services, completion, definition, error, formatting. The project needs to expose pretty much all the possibilities given by the typescript language service.

Service interface

The project services interfaces are pretty much all the time consuming/emitting positions based on line/column (see: https://github.com/TypeStrong/typescript-project-services/blob/master/src/main/index.ts#L10-L13), it's pretty handy for brackets-typescript, since it's the format used for codemirror, however will it be the case for atom-typescript ?
Also I guess we should integrate the project with tsconfig instead of using a custom config format

Tests

Some parts of the project are somewhat well tested (like project/projectManager) but some others are not tested at all, since the project want to become a foundation for other project it needs to be well-tested and we need code-coverage

Contributing

Finally we need a contributing.md+ code guideline, also we need to add tslint, that will help anybody that want to contribute to respect our coding standard.

Feel free to comment to give me your point of view, I'll edit the issue if I missed something.

Task list

• Find a better name for the project
• Let the users inject their own promise library
• Replace Make
• complete the test suite
• README.md
• Documentation (API + Usage)
• Expose the entire language service (through highlevel features)
  • won't expose cleanupSemanticCache(): void;
  • getSyntacticDiagnostics(fileName: string): Diagnostic[];
  • getSemanticDiagnostics(fileName: string): Diagnostic[];
  • getCompilerOptionsDiagnostics(): Diagnostic[];
  • won't expose getSyntacticClassifications(fileName: string, span: TextSpan): ClassifiedSpan[];
  • won't expose getSemanticClassifications(fileName: string, span: TextSpan): ClassifiedSpan[];
  • getCompletionsAtPosition(fileName: string, position: number): CompletionInfo;
  • getCompletionEntryDetails(fileName: string, position: number, entryName: string): CompletionEntryDetails;
  • getQuickInfoAtPosition(fileName: string, position: number): QuickInfo;
  • getNameOrDottedNameSpan(fileName: string, startPos: number, endPos: number): TextSpan;
  • won't expose getBreakpointStatementAtPosition(fileName: string, position: number): TextSpan;
  • getSignatureHelpItems(fileName: string, position: number): SignatureHelpItems;
  • getRenameInfo(fileName: string, position: number): RenameInfo;
  • findRenameLocations(fileName: string, position: number, findInStrings: boolean, findInComments: boolean): RenameLocation[];
  • getDefinitionAtPosition(fileName: string, position: number): DefinitionInfo[];
  • getReferencesAtPosition(fileName: string, position: number): ReferenceEntry[];
  • getOccurrencesAtPosition(fileName: string, position: number): ReferenceEntry[];
  • getNavigateToItems(searchValue: string): NavigateToItem[];
  • getNavigationBarItems(fileName: string): NavigationBarItem[];
  • getOutliningSpans(fileName: string): OutliningSpan[];
  • won't expose getTodoComments(fileName: string, descriptors: TodoCommentDescriptor[]): TodoComment[];
  • won't expose getBraceMatchingAtPosition(fileName: string, position: number): TextSpan[];
  • won't expose getIndentationAtPosition(fileName: string, position: number, options: EditorOptions): number;
  • getFormattingEditsForRange(fileName: string, start: number, end: number, options: FormatCodeOptions): TextChange[];
  • getFormattingEditsForDocument(fileName: string, options: FormatCodeOptions): TextChange[];
  • getFormattingEditsAfterKeystroke(fileName: string, position: number, key: string, options: FormatCodeOptions): TextChange[];
  • getEmitOutput(fileName: string): EmitOutput;
  • won't expose getSourceFile(filename: string): SourceFile;

Edit: added tslint part and tsconfig part
Edit2: added the task list
*Edit3 : remove bullet point that won't be addressed