✨ add prettier to dev deps (#181)

* ✨ add `prettier` to dev deps * 🚚 rename prettierignore * ✨ add `fmt` command to scritps * 🔧 update the prettier config * 🎨 format the code
nushell · Mar 26, 2024 · 92faaf7 · 92faaf7
1 parent ad9472e
commit 92faaf7
Show file tree

Hide file tree

Showing 21 changed files with 1,790 additions and 1,811 deletions.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -1,20 +1,15 @@
 /**@type {import('eslint').Linter.Config} */
 // eslint-disable-next-line no-undef
 module.exports = {
-	root: true,
-	parser: '@typescript-eslint/parser',
-	plugins: [
-		'@typescript-eslint',
-	],
-	extends: [
-		'eslint:recommended',
-		'plugin:@typescript-eslint/recommended',
-	],
-	rules: {
-		'semi': [2, "always"],
-		'@typescript-eslint/no-unused-vars': 0,
-		'@typescript-eslint/no-explicit-any': 0,
-		'@typescript-eslint/explicit-module-boundary-types': 0,
-		'@typescript-eslint/no-non-null-assertion': 0,
-	}
-};
+  root: true,
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint'],
+  extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended'],
+  rules: {
+    semi: [2, 'always'],
+    '@typescript-eslint/no-unused-vars': 0,
+    '@typescript-eslint/no-explicit-any': 0,
+    '@typescript-eslint/explicit-module-boundary-types': 0,
+    '@typescript-eslint/no-non-null-assertion': 0,
+  },
+};
diff --git a/.github/workflows/package.yml b/.github/workflows/package.yml
@@ -2,13 +2,13 @@
 
 name: CI
 
-# Controls when the action will run. 
+# Controls when the action will run.
 on:
   # Triggers the workflow on push or pull request events but only for the main branch
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
-    branches: [ main ]
+    branches: [main]
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -27,7 +27,7 @@ jobs:
       - run: npm install
       - uses: lannonbr/vsce-action@master
         with:
-          args: "package"
+          args: 'package'
 
       # Runs a single command using the runners shell
       # - name: Run a one-line script

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -4,20 +4,19 @@
 
 # Controls when the action will run.
 #on:
-  # Triggers the workflow on push or pull request events but only for the main branch
-  #push:
-  #  branches: [ main ]
-  #pull_request:
-  #  branches: [ main ]
-
+# Triggers the workflow on push or pull request events but only for the main branch
+#push:
+#  branches: [ main ]
+#pull_request:
+#  branches: [ main ]
 
 name: Create And Upload Release Asset
 
 on:
   push:
     # Sequence of patterns matched against refs/tags
     tags:
-    - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10
+      - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:

diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,5 @@
+# Ignore artifacts:
+build
+coverage
+out
+used_keywords.jsonc
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,4 @@
+{
+  "$schema": "https://json.schemastore.org/prettierrc",
+  "singleQuote": true
+}
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,10 +1,10 @@
 {
-	"editor.insertSpaces": false,
-	"typescript.tsc.autoDetect": "off",
-	"typescript.preferences.quoteStyle": "single",
-	"editor.codeActionsOnSave": {
-		"source.fixAll.eslint": "explicit"
-	},
-	"editor.formatOnSave": true,
-	"editor.defaultFormatter": "esbenp.prettier-vscode"
-}
+  "editor.insertSpaces": false,
+  "typescript.tsc.autoDetect": "off",
+  "typescript.preferences.quoteStyle": "single",
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit"
+  },
+  "editor.formatOnSave": true,
+  "editor.defaultFormatter": "esbenp.prettier-vscode"
+}
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
@@ -1,35 +1,31 @@
 // See https://go.microsoft.com/fwlink/?LinkId=733558
 // for the documentation about the tasks.json format
 {
-	"version": "2.0.0",
-	"tasks": [
-		{
-			"type": "npm",
-			"script": "compile",
-			"group": "build",
-			"presentation": {
-				"panel": "dedicated",
-				"reveal": "never"
-			},
-			"problemMatcher": [
-				"$tsc"
-			]
-		},
-		{
-			"type": "npm",
-			"script": "watch",
-			"isBackground": true,
-			"group": {
-				"kind": "build",
-				"isDefault": true
-			},
-			"presentation": {
-				"panel": "dedicated",
-				"reveal": "never"
-			},
-			"problemMatcher": [
-				"$tsc-watch"
-			]
-		}
-	]
-}
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "type": "npm",
+      "script": "compile",
+      "group": "build",
+      "presentation": {
+        "panel": "dedicated",
+        "reveal": "never"
+      },
+      "problemMatcher": ["$tsc"]
+    },
+    {
+      "type": "npm",
+      "script": "watch",
+      "isBackground": true,
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      },
+      "presentation": {
+        "panel": "dedicated",
+        "reveal": "never"
+      },
+      "problemMatcher": ["$tsc-watch"]
+    }
+  ]
+}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -166,4 +166,4 @@ All notable changes to the "vscode-nushell-lang" extension will be documented in
 - 1.9.0
   - Add spread to syntax highlighting [#174](https://github.com/nushell/vscode-nushell-lang/pull/174)
   - fix markdown formatting for hover lsp [#175](https://github.com/nushell/vscode-nushell-lang/pull/175)
-  - update grammar for nushell 0.91.0 [#177](https://github.com/nushell/vscode-nushell-lang/pull/177)
+  - update grammar for nushell 0.91.0 [#177](https://github.com/nushell/vscode-nushell-lang/pull/177)
diff --git a/client/src/extension.ts b/client/src/extension.ts
@@ -4,41 +4,41 @@
  * Licensed under the MIT License. See License.txt in the project root for license information.
  * ------------------------------------------------------------------------------------------ */
 
-import * as path from "path";
+import * as path from 'path';
 // import { workspace, ExtensionContext } from "vscode";
-import * as vscode from "vscode";
+import * as vscode from 'vscode';
 
 import {
   LanguageClient,
   LanguageClientOptions,
   ServerOptions,
   TransportKind,
-} from "vscode-languageclient/node";
+} from 'vscode-languageclient/node';
 
 let client: LanguageClient;
 
 export function activate(context: vscode.ExtensionContext) {
-  console.log("Terminals: " + (<any>vscode.window).terminals.length);
+  console.log('Terminals: ' + (<any>vscode.window).terminals.length);
   context.subscriptions.push(
-    vscode.window.registerTerminalProfileProvider("nushell_default", {
+    vscode.window.registerTerminalProfileProvider('nushell_default', {
       provideTerminalProfile(
-        token: vscode.CancellationToken
+        token: vscode.CancellationToken,
       ): vscode.ProviderResult<vscode.TerminalProfile> {
-        const which = require("which");
-        const path = require("path");
+        const which = require('which');
+        const path = require('path');
 
-        const PATH_FROM_ENV = process.env["PATH"];
+        const PATH_FROM_ENV = process.env['PATH'];
         const pathsToCheck = [
           PATH_FROM_ENV,
           // cargo install location
-          (process.env["CARGO_HOME"] || "~/.cargo") + "/bin",
+          (process.env['CARGO_HOME'] || '~/.cargo') + '/bin',
 
           // winget on Windows install location
-          "c:\\program files\\nu\\bin",
+          'c:\\program files\\nu\\bin',
           // just add a few other drives for fun
-          "d:\\program files\\nu\\bin",
-          "e:\\program files\\nu\\bin",
-          "f:\\program files\\nu\\bin",
+          'd:\\program files\\nu\\bin',
+          'e:\\program files\\nu\\bin',
+          'f:\\program files\\nu\\bin',
 
           // SCOOP:TODO
           // all user installed programs and scoop itself install to
@@ -60,40 +60,40 @@ export function activate(context: vscode.ExtensionContext) {
 
           // brew install location mac
           // intel
-          "/usr/local/bin",
+          '/usr/local/bin',
           // arm
-          "/opt/homebrew/bin",
+          '/opt/homebrew/bin',
 
           // native package manager install location
           // standard location should be in `PATH` env var
           //"/usr/bin/nu",
         ];
 
-        const found_nushell_path = which.sync("nu", {
+        const found_nushell_path = which.sync('nu', {
           nothrow: true,
           path: pathsToCheck.join(path.delimiter),
         });
 
         if (found_nushell_path == null) {
           console.log(
-            "Nushell not found in env:PATH or any of the heuristic locations."
+            'Nushell not found in env:PATH or any of the heuristic locations.',
           );
           // use an async arrow funciton to use `await` inside
           return (async () => {
             if (
               (await vscode.window.showErrorMessage(
-                "We cannot find a nushell executable in your path or pre-defined locations",
-                "install from website"
+                'We cannot find a nushell executable in your path or pre-defined locations',
+                'install from website',
               )) &&
               (await vscode.env.openExternal(
-                vscode.Uri.parse("https://www.nushell.sh/")
+                vscode.Uri.parse('https://www.nushell.sh/'),
               )) &&
               (await vscode.window.showInformationMessage(
-                "after you install nushell, you might need to reload vscode",
-                "reload now"
+                'after you install nushell, you might need to reload vscode',
+                'reload now',
               ))
             ) {
-              vscode.commands.executeCommand("workbench.action.reloadWindow");
+              vscode.commands.executeCommand('workbench.action.reloadWindow');
             }
             // user has already seen error messages, but they didn't click through
             // return a promise that never resolve to supress the confusing error
@@ -103,26 +103,26 @@ export function activate(context: vscode.ExtensionContext) {
 
         return {
           options: {
-            name: "Nushell",
+            name: 'Nushell',
             shellPath: found_nushell_path,
             iconPath: vscode.Uri.joinPath(
               context.extensionUri,
-              "assets/nu.svg"
+              'assets/nu.svg',
             ),
           },
         };
       },
-    })
+    }),
   );
 
   // The server is implemented in node
   const serverModule = context.asAbsolutePath(
-    path.join("out", "server", "src", "server.js")
+    path.join('out', 'server', 'src', 'server.js'),
   );
 
   // The debug options for the server
   // --inspect=6009: runs the server in Node's Inspector mode so VS Code can attach to the server for debugging
-  const debugOptions = { execArgv: ["--nolazy", "--inspect=6009"] };
+  const debugOptions = { execArgv: ['--nolazy', '--inspect=6009'] };
 
   // If the extension is launched in debug mode then the debug server options are used
   // Otherwise the run options are used
@@ -138,10 +138,10 @@ export function activate(context: vscode.ExtensionContext) {
   // Options to control the language client
   const clientOptions: LanguageClientOptions = {
     // Register the server for plain text documents
-    documentSelector: [{ scheme: "file", language: "nushell" }],
+    documentSelector: [{ scheme: 'file', language: 'nushell' }],
     synchronize: {
       // Notify the server about file changes to '.clientrc files contained in the workspace
-      fileEvents: vscode.workspace.createFileSystemWatcher("**/.clientrc"),
+      fileEvents: vscode.workspace.createFileSystemWatcher('**/.clientrc'),
     },
     markdown: {
       isTrusted: true
@@ -150,10 +150,10 @@ export function activate(context: vscode.ExtensionContext) {
 
   // Create the language client and start the client.
   client = new LanguageClient(
-    "nushellLanguageServer",
-    "Nushell Language Server",
+    'nushellLanguageServer',
+    'Nushell Language Server',
     serverOptions,
-    clientOptions
+    clientOptions,
   );
 
   // Start the client. This will also launch the server