Merge pull request #109 from zardoy/develop

Author: zardoy

.github/workflows/ci.yml

@@ -6,13 +6,13 @@ jobs:
   test:
     strategy:
       matrix:
-        os: [ubuntu-latest, macos-latest, windows-latest]
+        os: [ubuntu-latest, windows-latest]
       fail-fast: true
     runs-on: ${{ matrix.os }}
     timeout-minutes: 30
     steps:
       - uses: actions/checkout@v2
-      - run: npx prettier --check src/**
+      - run: npx prettier --check "{src,typescript}/**/*.ts" --ignore-path .gitignore
       - name: Cache pnpm modules
         uses: actions/cache@v2
         with:

.github/workflows/release.yml

@@ -13,7 +13,6 @@ jobs:
       - run: npm -v
       - run: node -v
       - uses: actions/checkout@v2
-      - run: npx prettier --check src/**
       - name: Cache pnpm modules
         uses: actions/cache@v2
         with:
@@ -26,7 +25,6 @@ jobs:
           version: latest
           run_install: |
             args: [--frozen-lockfile, --strict-peer-dependencies]
-      - run: pnpm lint
       - run: pnpx zardoy-release vscode-extension
         env:
           GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}

README.MD

@@ -7,7 +7,9 @@ TOC:
 
 - [Top Features](#top-features)
 - [Minor Useful Features](#minor-useful-features)
+- [Method Snippets](#method-snippets)
 - [Auto Imports](#auto-imports)
+- [Type Driven Completions](#type-driven-completions)
 - [Rename Features](#rename-features)
 - [Special Commands List](#special-commands-list)
 - [Contributed Code Actions](#contributed-code-actions)
@@ -35,19 +37,6 @@ Also is not supported in the web.
 
 90% work done in this extension highly improves completions experience!
 
-### Method Snippets
-
-(*enabled by default*)
-
-Expands arrow callbacks with signature snippet with adding additional undo stack!
-
-Example:
-
-```ts
-const callback = (arg) => {}
-callback -> callback(arg)
-```
-
 ### Strict Emmet
 
 (*enabled by default*) when react langs are in `emmet.excludeLanguages`
@@ -127,7 +116,9 @@ There is web-only feature: fix clicking on relative `import` paths.
 
 (*enabled by default*)
 
-Highlights and lifts non-function methods. Also applies for static class methods.
+Highlights non-function methods and properties. Also applies for static class methods.
+
+![non-function-methods](media/non-function-methods.png)
 
 ### Indexed Signature Completions
 
@@ -175,8 +166,6 @@ Try to restore [original](https://github.com/microsoft/TypeScript/issues/49012)
 We extend completion list with extensions from module augmentation (e.g. `.css` files if you have `declare module '*.css'`).
 But for unchecked contexts list of extensions can be extended with `tsEssentialPlugins.additionalIncludeExtensions` setting.
 
-<!-- ## Type-Driven Completions -->
-
 ### Mark Code Actions
 
 (*enabled by default* with two settings)
@@ -205,6 +194,102 @@ const a = 5
 a = 6
 ```
 
+### Format Ignore Directives
+
+We support [format ignore directives](https://github.com/microsoft/TypeScript/issues/18261)
+
+## Type-Driven Completions
+
+All in this section requires TypeScript nightly extension.
+
+### JSX Elements
+
+To Enable: `"tsEssentialPlugins.experiments.excludeNonJsxCompletions": true`
+
+We can filter out completions so only Function Components stay in your list:
+
+```tsx
+class Foo {}
+const Bar = () => <div />
+
+const elem = </* Bar is suggested, Foo not
+```
+
+Super handy in MUI + Electron projects.
+
+Class components are not supported (no need).
+
+### Change kind to function
+
+Enable with `tsEssentialPlugins.experiments.changeKindToFunction`
+
+![change-icon-kind](media/change-kind.png)
+
+## Method Snippets
+
+(*enabled by default*)
+
+Expands arrow callback completions with signature snippet. Also adds additional undo stack!
+
+Example:
+
+```ts
+const callback = (arg) => {}
+callback -> callback(arg)
+```
+
+#### Configuration
+
+There are value descriptions for two settings:
+
+`tsEssentialPlugins.methodSnippets.insertText`:
+
+```ts
+const example = ({ a }, b?, c = 5, ...d) => { }
+// binding-name (default)
+example({ a }, b, c, ...d)
+// always-declaration (also popular)
+example({ a }, b?, c = 5, ...d)
+// always-name
+example(__0, b, c, d)
+```
+
+`tsEssentialPlugins.methodSnippets.skip`:
+
+```ts
+const example = ({ a }, b?, c = 5, ...d) => { }
+// only-rest
+example({ a }, b, c)
+// optional-and-rest
+example({ a })
+// no-skip (default)
+example({ a }, b, c, ...d)
+```
+
+`tsEssentialPlugins.methodSnippets.multipleSignatures`:
+
+```ts
+// overload 1
+function foo(this: {}, a)
+// overload 2
+function foo(this: {}, b)
+function foo(this: {}) {}
+
+// pick-first (default)
+foo(a)
+// empty
+foo(|)
+```
+
+`disableMethodSnippets.jsxAttributes`:
+
+```tsx
+const callback = (arg) => {}
+function Foo() {
+    return <div onClick={callback/* when true (default) - no expansion here */} />
+}
+```
+
 ## Auto Imports
 
 With this plugin you have total (almost) control over auto imports that appear in completions, quick fixes and import all quick fix. Some examples of what you can do:
@@ -320,7 +405,9 @@ Another options that is accepted is
 
 ### Go to / Select Nodes by Kind
 
-Use cases: search excluding comments, search & replace only within strings, find interested JSX attribute node
+Extremely powerful command that allows you to leverage AST knowledge of opened file.
+
+Use cases: select all comments to exclude searching in comments. Or search & replace only within strings / find interested JSX attribute node.
 
 ## Contributed Code Actions
 

REFACTOR-EXTENSIONS-COMPARING.MD

@@ -0,0 +1,10 @@
+# VS CODE Refactor Extensions Comparing
+
+All of these extensions are free to use and can be used offline.
+
+| Extension                                                                                                       | Good number of actions | Actions quality                                                            | Performance Optimizations                           |
+| --------------------------------------------------------------------------------------------------------------- | ---------------------- | -------------------------------------------------------------------------- | --------------------------------------------------- |
+| [JS Refactor :: JS CodeFormer](https://marketplace.visualstudio.com/items?itemName=cmstead.jsrefactor)          | ✅                      | ❌ (Extension abandoned)                                                    | ?                                                   |
+| [Abracadabra, refactor this!](https://marketplace.visualstudio.com/items?itemName=nicoespeon.abracadabra)       | ✅                      | ❌ Sometimes buggy, doesn't work with syntax errors, no TS types auto-infer | ❌ (Uses extension host, slow downs other extension) |
+| [JS Refactoring Assistant (P42)](https://marketplace.visualstudio.com/items?itemName=p42ai.refactor)            | ✅                      | JS - ✅, TS - ❌ (You need to write types yourself)                          | ✅ (Dedicated language server)                       |
+| [TypeScript Essential Plugins](https://marketplace.visualstudio.com/items?itemName=zardoy.ts-essential-plugins) | ❌                      | ✅? (Auto infers types, but missing a lot of tests)                         | ✅ (Best possible, reuses TS language server)        |

integration/index.ts

@@ -13,7 +13,20 @@ export const run = async () => {
         glob('**/**.test.js', { cwd: testsRoot }, (err, files) => {
             if (err) throw err
 
-            for (const file of files) mocha.addFile(join(testsRoot, file))
+            const preFiles = [] as string[]
+            const postFiles = ['outline.test.js'] as string[]
+
+            for (const file of preFiles) {
+                mocha.addFile(join(testsRoot, file))
+            }
+
+            for (const file of files.filter(file => !preFiles.includes(file) && !postFiles.includes(file))) {
+                mocha.addFile(join(testsRoot, file))
+            }
+
+            for (const file of postFiles) {
+                mocha.addFile(join(testsRoot, file))
+            }
 
             mocha.run(failures => {
                 if (failures > 0) {

integration/suite/completions.test.ts

@@ -104,7 +104,7 @@
         "test-plugin": "vitest --globals --dir typescript/test/ --environment ts-plugin",
         "integration-test": "node integration/prerun.mjs && tsc -p tsconfig.test.json && node testsOut/runTests.js",
         "integration-test:watch": "chokidar \"integration/**\" -c \"pnpm integration-test\" --initial",
-        "postinstall": "patch-package"
+        "postinstall": "patch-package && tsm ./typescript/scripts/patchModules.ts"
     },
     "devDependencies": {
         "@milahu/patch-package-with-pnpm-support": "^6.4.8",
@@ -123,7 +123,8 @@
         "vite": "^4.1.1",
         "vitest": "^0.26.0",
         "vitest-environment-ts-plugin": "./vitest-environment-ts-plugin",
-        "vscode-manifest": "^0.0.4"
+        "vscode-manifest": "^0.0.4",
+        "tsm": "^2.3.0"
     },
     "pnpm": {
         "overrides": {