feat: added support for sendWatchChangeRequest, jsxClosingTag, getLinkedEditingRange, braceCommand, braceCompletion, getSpanOfEnclosingComment,

charlypa · charlypa · commit e1f8b417c4bb · 2024-01-06T18:13:04.000+05:30
diff --git a/README.md b/README.md
@@ -1,184 +1,24 @@
-# template-nodejs
-A template project for nodejs. Has integrated linting, testing,
-coverage, reporting, GitHub actions for publishing to npm repository, dependency updates and other goodies.
+# TypeScript Server Instance Project
 
-Easily use this template to quick start a production ready nodejs project template.
+A robust project for managing and interacting with a TypeScript Server (TSServer). It includes an extensive array of functionalities such as file manipulation, code analysis, formatting, refactoring, and more, making it an ideal starting point for any TypeScript project requiring direct interaction with TSServer.
 
 ## Code Guardian
-[![<app> build verification](https://github.com/aicore/template-nodejs/actions/workflows/build_verify.yml/badge.svg)](https://github.com/aicore/template-nodejs/actions/workflows/build_verify.yml)
-
-<a href="https://sonarcloud.io/summary/new_code?id=aicore_template-nodejs-ts">
-  <img src="https://sonarcloud.io/api/project_badges/measure?project=aicore_template-nodejs-ts&metric=alert_status" alt="Sonar code quality check" />
-  <img src="https://sonarcloud.io/api/project_badges/measure?project=aicore_template-nodejs-ts&metric=security_rating" alt="Security rating" />
-  <img src="https://sonarcloud.io/api/project_badges/measure?project=aicore_template-nodejs-ts&metric=vulnerabilities" alt="vulnerabilities" />
-  <img src="https://sonarcloud.io/api/project_badges/measure?project=aicore_template-nodejs-ts&metric=coverage" alt="Code Coverage" />
-  <img src="https://sonarcloud.io/api/project_badges/measure?project=aicore_template-nodejs-ts&metric=bugs" alt="Code Bugs" />
-  <img src="https://sonarcloud.io/api/project_badges/measure?project=aicore_template-nodejs-ts&metric=reliability_rating" alt="Reliability Rating" />
-  <img src="https://sonarcloud.io/api/project_badges/measure?project=aicore_template-nodejs-ts&metric=sqale_rating" alt="Maintainability Rating" />
-  <img src="https://sonarcloud.io/api/project_badges/measure?project=aicore_template-nodejs-ts&metric=ncloc" alt="Lines of Code" />
-  <img src="https://sonarcloud.io/api/project_badges/measure?project=aicore_template-nodejs-ts&metric=sqale_index" alt="Technical debt" />
-</a>
-
-
-# TODOs after template use
-## !!!Please see all issues in the generated repository as an issue will be generated tracking the fix of each of the below items.  
-1. Update package.json with your app defaults
-2. Check Build actions on pull requests.
-3. create a home page in wiki by going to wiki link https://github.com/<your_org>/<your_repo>/wiki
-4. Goto github `repository` > `settings`> and uncheck `Allow merge commits`. this is usually automatically done by code guardian bots in core.ai org. so you may just need to verify it.
-5. In sonar cloud, enable Automatic analysis from `Administration
-   Analysis Method` for the first time before a pull request is raised: ![image](https://user-images.githubusercontent.com/5336369/148695840-65585d04-5e59-450b-8794-54ca3c62b9fe.png)
-6. Check codacy runs on pull requests, set codacy defaults. You may remove codacy if sonar cloud is only needed.
-7. Update the above Code Guardian badges; change all `id=aicore_template-nodejs-ts` to the sonar id of your project fields. see this PR: https://github.com/aicore/libcache/pull/13
+[![TSServer Instance build verification](https://github.com/aicore/template-nodejs/actions/workflows/build_verify.yml/badge.svg)](https://github.com/aicore/template-nodejs/actions/workflows/build_verify.yml)
 
 # Commands available
 
-## Building
-Since this is a pure JS template project, build command just runs test with coverage.
+## Initialization
+To initialize the TypeScript Server:
 ```shell
 > npm install   // do this only once.
-> npm run build
-```
-
-## Linting
-To lint the files in the project, run the following command:
-```shell
-> npm run lint
-```
-To Automatically fix lint errors:
-```shell
-> npm run lint:fix
-```
-
-## Testing
-To run all tests:
-```shell
-> npm run test
-  Hello world Tests
-    ✔ should return Hello World
-    #indexOf()
-      ✔ should return -1 when the value is not present
-```
-
-Additionally, to run unit/integration tests only, use the commands:
-```shell
-> npm run test:unit
-> npm run test:integ
-```
-
-## Coverage Reports
-To run all tests with coverage:
-
-```shell
-> npm run cover
-  Hello world Tests
-    ✔ should return Hello World
-    #indexOf()
-      ✔ should return -1 when the value is not present
-
-
-  2 passing (6ms)
-
-----------|---------|----------|---------|---------|-------------------
-File      | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line #s 
-----------|---------|----------|---------|---------|-------------------
-All files |     100 |      100 |     100 |     100 |                   
- index.js |     100 |      100 |     100 |     100 |                   
-----------|---------|----------|---------|---------|-------------------
-
-=============================== Coverage summary ===============================
-Statements   : 100% ( 5/5 )
-Branches     : 100% ( 2/2 )
-Functions    : 100% ( 1/1 )
-Lines        : 100% ( 5/5 )
-================================================================================
-Detailed unit test coverage report: file:///template-nodejs/coverage-unit/index.html
-Detailed integration test coverage report: file:///template-nodejs/coverage-integration/index.html
-```
-After running coverage, detailed reports can be found in the coverage folder listed in the output of coverage command.
-Open the file in browser to view detailed reports.
-
-To run unit/integration tests only with coverage
-```shell
-> npm run cover:unit
-> npm run cover:integ
-```
-
-Sample coverage report:
-![image](https://user-images.githubusercontent.com/5336369/148687351-6d6c12a2-a232-433d-ab62-2cf5d39c96bd.png)
-
-### Unit and Integration coverage configs
-Unit and integration test coverage settings can be updated by configs `.nycrc.unit.json` and `.nycrc.integration.json`.
-
-See https://github.com/istanbuljs/nyc for config options.
-
-# Publishing packages to NPM
-
-  ## Preparing for release
-  Please run `npm run release` on the `main` branch and push the changes to main. The release command will bump the npm version.
-  
-  !NB: NPM publish will faill if there is another release with the same version.
-  ## Publishing
-To publish a package to npm, push contents to `npm` branch in 
-this repository. 
-
-## Publishing `@aicore/package*`
-If you are looking to publish to package owned by core.ai, you will need access to the GitHub Organization secret `NPM_TOKEN`.
-
-For repos managed by [aicore](https://github.com/aicore) org in GitHub, Please contact your Admin to get access to core.ai's NPM tokens.
-
-
-## Publishing to your own npm account
-Alternatively, if you want to publish the package to your own npm account, please follow these docs:
-1. Create an automation access token by following this [link](https://docs.npmjs.com/creating-and-viewing-access-tokens).
-2. Add NPM_TOKEN to your repository secret by following this [link](https://docs.npmjs.com/using-private-packages-in-a-ci-cd-workflow)
-
-To edit the publishing workflow, please see file: `.github/workflows/npm-publish.yml`
-
-
-# Dependency updates
-  We use Rennovate for dependency updates: https://blog.logrocket.com/renovate-dependency-updates-on-steroids/
-  * By default, dep updates happen on sunday every week.
-  * The status of dependency updates can be viewed here if you have this repo permissions in github: https://app.renovatebot.com/dashboard#github/aicore/template-nodejs
-  * To edit rennovate options, edit the rennovate.json file in root, see https://docs.renovatebot.com/configuration-options/
-  Refer 
-  
-# Code Guardian
-Several automated workflows that check code integrity are integrated into this template.
-These include:
-1. GitHub actions that runs build/test/coverage flows when a contributor raises a pull request
-2. [Sonar cloud](https://sonarcloud.io/) integration using `.sonarcloud.properties`
-   1. In sonar cloud, enable Automatic analysis from `Administration
-      Analysis Method` for the first time ![image](https://user-images.githubusercontent.com/5336369/148695840-65585d04-5e59-450b-8794-54ca3c62b9fe.png)
-
-## IDE setup
-SonarLint is currently available as a free plugin for jetbrains, eclipse, vscode and visual studio IDEs.
-Use sonarLint plugin for webstorm or any of the available
-IDEs from this link before raising a pull request: https://www.sonarlint.org/ .
-
-SonarLint static code analysis checker is not yet available as a Brackets
-extension.
-
-## Internals
-### Testing framework: Mocha , assertion style: chai
- See https://mochajs.org/#getting-started on how to write tests
- Use chai for BDD style assertions (expect, should etc..). See move here: https://www.chaijs.com/guide/styles/#expect
-
-### Mocks and spies:
+> node -e 'require("./path-to-createTSServerInstance").init()'
+# Usage and Examples
 
- Since it is not that straight forward to mock es6 module imports, use the follow pull request as reference to mock
-imported libs:
- 
+This TypeScript Server (TSServer) Instance project provides a wide range of functionalities to interact with TypeScript Server. Below are examples of how you can use these functionalities.
 
-* sample pull request: https://github.com/aicore/libcache/pull/6/files
-* [setting up mocks](https://github.com/aicore/libcache/blob/485b1b6244f7022eb0a83d9f72d897fe712badbe/test/unit/setup-mocks.js)
-* [using the mocks](https://github.com/aicore/libcache/pull/6/files#diff-8ea7ccf28b28a0ae7b43e468abd3e9a8bb411bb329ad5cb45eb9a93709ed8dc5R2)
-ensure to import `setup-mocks.js` as the first import of all files in tests.
+## Initialization
 
-#### using sinon lib if the above method doesn't fit your case
-if you want to mock/spy on fn() for unit tests, use sinon. refer docs: https://sinonjs.org/
+Before you start, make sure to initialize the TypeScript Server:
 
-### Note on coverage suite used here:
-we use c8 for coverage https://github.com/bcoe/c8. Its reporting is based on nyc, so detailed docs can be found
- here: https://github.com/istanbuljs/nyc ; We didn't use nyc as it do not yet have ES module support
- see: https://github.com/digitalbazaar/bedrock-test/issues/16 . c8 is drop replacement for nyc coverage reporting tool
+```javascript
+const tsServer = require('./path-to-createTSServerInstance').init();
diff --git a/src/exp.js b/src/exp.js
@@ -189,5 +189,25 @@ for (let file of FILES) {
     await tsServer.openFile(file.prepareCallHierarchy.filePath);
     const provideCallHierarchyOutgoingCallsResponse = await tsServer.provideCallHierarchyOutgoingCalls(file.prepareCallHierarchy.filePath, file.prepareCallHierarchy.line, file.prepareCallHierarchy.offset);
     console.log('provideCallHierarchyOutgoingCallsResponse', JSON.stringify(provideCallHierarchyOutgoingCallsResponse));
+
+    await tsServer.openFile(file.getLinkedEditingRange.filePath);
+    const getLinkedEditingRangeResponse = await tsServer.getLinkedEditingRange(file.getLinkedEditingRange.filePath, file.getLinkedEditingRange.line, file.getLinkedEditingRange.offset);
+    console.log('getLinkedEditingRangeResponse', JSON.stringify(getLinkedEditingRangeResponse));
+
+    await tsServer.openFile(file.braceCommand.filePath);
+    const braceCommandResponse = await tsServer.braceCommand(file.braceCommand.filePath, file.braceCommand.line, file.braceCommand.offset);
+    console.log('braceCommandResponse', JSON.stringify(braceCommandResponse));
+
+    // TODO: see working and non-working use case
+    await tsServer.openFile(file.braceCommand.filePath);
+    const braceCompletionResponse = await tsServer.braceCompletion(file.braceCommand.filePath, file.braceCommand.line + 1, file.braceCommand.offset, 'a');
+    console.log('braceCompletionResponse', JSON.stringify(braceCompletionResponse));
+
+    await tsServer.openFile(file.braceCommand.filePath);
+    const getSpanOfEnclosingCommentResponse = await tsServer.getSpanOfEnclosingComment(file.getSpanOfEnclosingComment.filePath, file.getSpanOfEnclosingComment.line, file.getSpanOfEnclosingComment.offset, file.getSpanOfEnclosingComment.onlyMultiLine);
+    console.log('getSpanOfEnclosingCommentResponse', JSON.stringify(getSpanOfEnclosingCommentResponse));
 }
-//tsServer.exitServer();
+/*
+tsServer.exitServer();
+tsServer.killServer();
+*/
diff --git a/src/test/sample/getLinkedEditingRange/sample.tsx b/src/test/sample/getLinkedEditingRange/sample.tsx
@@ -0,0 +1,24 @@
+import React from 'react';
+
+const SampleComponent = () => {
+    return (
+        <div>
+            <header>
+                <h1>Welcome to My App</h1>
+            </header>
+            <main>
+                <section>
+                    <p>This is a paragraph in a section.</p>
+                </section>
+                <article>
+                    <p>This is an article.</p>
+                </article>
+            </main>
+            <footer>
+                <p>Footer content goes here.</p>
+            </footer>
+        </div>
+    );
+};
+
+export default SampleComponent;
diff --git a/src/test/sample/jsxClosingTag/src/JSXFile.tsx b/src/test/sample/jsxClosingTag/src/JSXFile.tsx
@@ -0,0 +1,14 @@
+import React from 'react';
+
+const SampleComponent = () => {
+    return (
+        <div>
+            <h1>Welcome to the Sample Component</h1>
+            <p>This is a paragraph within the sample component.</p>
+            <input type="text" placeholder="Enter text here" />
+            <button>Click Me</button>
+        </div>
+    );
+};
+
+export default SampleComponent;
diff --git a/src/test/sample/jsxClosingTag/tsconfig.json b/src/test/sample/jsxClosingTag/tsconfig.json
@@ -0,0 +1,32 @@
+{
+  "compilerOptions": {
+    "target": "es5", // Specify ECMAScript target version
+    "lib": [
+      "dom",
+      "dom.iterable",
+      "esnext"
+    ], // List of library files to be included in the compilation
+    "allowJs": true, // Allow JavaScript files to be compiled
+    "skipLibCheck": true, // Skip type checking of all declaration files
+    "esModuleInterop": true, // Disables namespace imports (import * as fs from "fs") and enables CJS/AMD/UMD style imports (import fs from "fs")
+    "allowSyntheticDefaultImports": true, // Allow default imports from modules with no default export
+    "strict": true, // Enable all strict type checking options
+    "forceConsistentCasingInFileNames": true, // Disallow inconsistently-cased references to the same file.
+    "module": "esnext", // Specify module code generation
+    "moduleResolution": "node", // Resolve modules using Node.js style
+    "isolatedModules": true, // Unconditionally emit imports for unresolved files
+    "resolveJsonModule": true, // Include modules imported with .json extension
+    "noEmit": true, // Do not emit output (meaning do not compile code, only perform type checking)
+    "jsx": "react", // Support JSX in .tsx files
+    "sourceMap": true, // Generate corrresponding .map file
+    "declaration": true, // Generate corresponding .d.ts file
+    "noUnusedLocals": true, // Report errors on unused locals
+    "noUnusedParameters": true, // Report errors on unused parameters
+    "incremental": true, // Enable incremental compilation by reading/writing information from prior compilations to a file on disk
+    "noFallthroughCasesInSwitch": true // Report errors for fallthrough cases in switch statement
+  },
+  "include": [
+    "src/**/*" // *** The files TypeScript should type check ***
+  ],
+  "exclude": ["node_modules", "build"] // *** The files to not type check ***
+}
diff --git a/src/utils/server.js b/src/utils/server.js
diff --git a/src/utils/testconfig.js b/src/utils/testconfig.js
