Merge branch 'main' into generate-examples

Author: pokey

.eslintrc.json

@@ -10,8 +10,11 @@
 		"ecmaVersion": 6,
 		"sourceType": "module"
 	},
-	"plugins": ["@typescript-eslint"],
+	"plugins": ["@typescript-eslint", "unused-imports"],
 	"rules": {
+		// Note: you must disable the base rule as it can report incorrect errors
+		"no-restricted-imports": "off",
+		"@typescript-eslint/no-restricted-imports": "error",
 		"@typescript-eslint/consistent-type-assertions": [
 			"error",
 			{
@@ -22,6 +25,7 @@
 		"@typescript-eslint/no-explicit-any": "off",
 		"@typescript-eslint/no-inferrable-types": "off",
 		"@typescript-eslint/no-non-null-assertion": "off",
+		"unused-imports/no-unused-imports": "error",
 		"@typescript-eslint/no-unused-vars": [
 			"warn",
 			{
@@ -38,7 +42,12 @@
 				"null": "never"
 			}
 		],
-		"no-constant-condition": ["error", { "checkLoops": false }],
+		"no-constant-condition": [
+			"error",
+			{
+				"checkLoops": false
+			}
+		],
 		"no-throw-literal": "warn",
 		"semi": "off"
 	},

.git-blame-ignore-revs

@@ -1 +1,2 @@
 4c0676728c0ccfdcc4b6593a4a13ac49fc20a82a
+619d7f7271506c7fd5913cca68574f722ab392d8

.github/FUNDING.yml

@@ -1,3 +1,5 @@
 ## Checklist
 
 - [ ] I have added [tests](https://www.cursorless.org/docs/contributing/test-case-recorder/)
+- [ ] I have updated the [docs](https://github.com/cursorless-dev/cursorless/tree/main/docs) and [cheatsheet](https://github.com/cursorless-dev/cursorless/tree/main/cursorless-talon/src/cheatsheet)
+- [ ] I have not broken the cheatsheet

.github/PULL_REQUEST_TEMPLATE.md

@@ -12,10 +12,10 @@ jobs:
     if: ${{ github.event.workflow_run.conclusion == 'success' }}
     environment: production
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           fetch-depth: 0
-      - uses: actions/setup-node@v2
+      - uses: actions/setup-node@v3
         with:
           node-version: 16
           cache: yarn
@@ -46,7 +46,7 @@ jobs:
     needs: publish-extension
     environment: production
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           fetch-depth: 0
           token: ${{ secrets.CURSORLESS_BOT_TOKEN }}

.github/workflows/deploy.yaml

@@ -9,8 +9,8 @@ jobs:
   test-docs-build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
         with:
           node-version: 16
           cache: yarn

.github/workflows/test-docs.yml

@@ -23,8 +23,8 @@ jobs:
     env:
       VSCODE_VERSION: ${{ matrix.vscode_version }}
     steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
         with:
           node-version: 16
           cache: yarn

.github/workflows/test.yml

@@ -9,8 +9,5 @@ node_modules
 # TypeDoc output
 docs/contributing/api/
 
-# Generated docs hub
-website-root/docs/
-
 # Local extension / data sandbox for debug launch task
 /.vscode-sandbox

.gitignore

@@ -32,9 +32,14 @@ repos:
     hooks:
       - id: flynt
   - repo: https://github.com/Zac-HD/shed
-    rev: 0.10.1
+    rev: 0.10.7
     hooks:
       - id: shed
         # TODO: bump to --py310-plus when Talon moves to Python 3.10.
         args: [--refactor, --py39-plus]
         types_or: [python, markdown, rst]
+  - repo: https://github.com/wenkokke/talonfmt
+    rev: 1.8.1
+    hooks:
+      - id: talonfmt
+        args: ["--in-place", "--max-line-width=88"]

.pre-commit-config.yaml

@@ -2,3 +2,7 @@
 
 # We use our own format for our recorded yaml tests to keep them compact
 /src/test/suite/fixtures/recorded/**/*.yml
+
+
+# This was swizzled from a Docusaurus core class
+docs-site/src/theme/SearchBar/index.js

.prettierignore

@@ -0,0 +1,3 @@
+{
+  "trailingComma": "all"
+}

.prettierrc

@@ -44,9 +44,25 @@
 			"args": [
 				"--extensions-dir=${workspaceFolder}/.vscode-sandbox/extensions",
 				"--extensionDevelopmentPath=${workspaceFolder}",
-				"--extensionTestsPath=${workspaceFolder}/out/test/suite/index"
+				"--extensionTestsPath=${workspaceFolder}/out/test/runners/all"
 			],
-			"outFiles": ["${workspaceFolder}/out/test/**/*.js"],
+			"outFiles": ["${workspaceFolder}/out/**/*.js"],
+			"preLaunchTask": "${defaultBuildTask}",
+			"resolveSourceMapLocations": [
+				"${workspaceFolder}/**",
+				"!${workspaceFolder}/.vscode-sandbox/**",
+				"!**/node_modules/**"
+			]
+		},
+		{
+			"type": "node",
+			"request": "launch",
+			"name": "Unit tests only",
+			"program": "${workspaceFolder}/out/test/scripts/runUnitTestsOnly",
+			"env": {
+				"CURSORLESS_TEST": "true"
+			},
+			"outFiles": ["${workspaceFolder}/out/**/*.js"],
 			"preLaunchTask": "${defaultBuildTask}",
 			"resolveSourceMapLocations": [
 				"${workspaceFolder}/**",
@@ -65,9 +81,9 @@
 			"args": [
 				"--extensions-dir=${workspaceFolder}/.vscode-sandbox/extensions",
 				"--extensionDevelopmentPath=${workspaceFolder}",
-				"--extensionTestsPath=${workspaceFolder}/out/test/suite/index"
+				"--extensionTestsPath=${workspaceFolder}/out/test/runners/all"
 			],
-			"outFiles": ["${workspaceFolder}/out/test/**/*.js"],
+			"outFiles": ["${workspaceFolder}/out/**/*.js"],
 			"preLaunchTask": "${defaultBuildTask}",
 			"resolveSourceMapLocations": [
 				"${workspaceFolder}/**",
@@ -86,9 +102,9 @@
 			"args": [
 				"--extensions-dir=${workspaceFolder}/.vscode-sandbox/extensions",
 				"--extensionDevelopmentPath=${workspaceFolder}",
-				"--extensionTestsPath=${workspaceFolder}/out/test/suite/index"
+				"--extensionTestsPath=${workspaceFolder}/out/test/runners/all"
 			],
-			"outFiles": ["${workspaceFolder}/out/test/**/*.js"],
+			"outFiles": ["${workspaceFolder}/out/**/*.js"],
 			"preLaunchTask": "${defaultBuildTask}",
 			"resolveSourceMapLocations": [
 				"${workspaceFolder}/**",
@@ -108,9 +124,9 @@
 			"args": [
 				"--extensions-dir=${workspaceFolder}/.vscode-sandbox/extensions",
 				"--extensionDevelopmentPath=${workspaceFolder}",
-				"--extensionTestsPath=${workspaceFolder}/out/test/suite/index"
+				"--extensionTestsPath=${workspaceFolder}/out/test/runners/all"
 			],
-			"outFiles": ["${workspaceFolder}/out/test/**/*.js"],
+			"outFiles": ["${workspaceFolder}/out/**/*.js"],
 			"preLaunchTask": "${defaultBuildTask}",
 			"resolveSourceMapLocations": [
 				"${workspaceFolder}/**",
@@ -122,14 +138,26 @@
 			"name": "Docusaurus Start (Debug)",
 			"type": "node",
 			"request": "launch",
-			"cwd": "${workspaceFolder}/website",
+			"cwd": "${workspaceFolder}/docs-site",
 			"runtimeExecutable": "npm",
 			"runtimeArgs": ["run", "start"],
 			"resolveSourceMapLocations": [
 				"${workspaceFolder}/**",
 				"!${workspaceFolder}/.vscode-sandbox/**",
 				"!**/node_modules/**"
 			]
+		},
+		{
+			"name": "cursorless.org client-side",
+			"type": "chrome",
+			"request": "launch",
+			"url": "http://localhost:4200",
+			"webRoot": "${workspaceFolder}/cursorless-nx",
+			"sourceMapPathOverrides": {
+				"webpack://_N_E/*": "${webRoot}/apps/cursorless-org/*",
+				"webpack://_N_E/libs/*": "${webRoot}/libs/*",
+				"webpack://_N_E/node_modules/*": "${webRoot}/node_modules/*"
+			}
 		}
 	]
 }

.vscode/launch.json

@@ -41,6 +41,30 @@
 				"reveal": "never"
 			},
 			"group": "build"
+		},
+		{
+			"label": "Serve cursorless.org",
+			"type": "shell",
+			"command": "nx serve cursorless-org",
+			"options": {
+				"cwd": "cursorless-nx"
+			},
+			"problemMatcher": []
+		},
+		{
+			"label": "Install local",
+			"type": "shell",
+			"command": "vsce package -o bundle.vsix && code --install-extension bundle.vsix",
+			"presentation": {
+				"focus": true
+			},
+			"problemMatcher": []
+		},
+		{
+			"label": "Run pre commit",
+			"type": "shell",
+			"command": "pre-commit run",
+			"presentation": {}
 		}
 	]
 }

.vscode/tasks.json

@@ -0,0 +1,10 @@
+{
+	"extends": ["plugin:cypress/recommended", "../../.eslintrc.json"],
+	"ignorePatterns": ["!**/*"],
+	"overrides": [
+		{
+			"files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+			"rules": {}
+		}
+	]
+}

cursorless-nx/apps/cheatsheet-local/src/favicon.ico

@@ -0,0 +1,12 @@
+{
+	"fileServerFolder": ".",
+	"fixturesFolder": "./src/fixtures",
+	"integrationFolder": "./src/integration",
+	"modifyObstructiveCode": false,
+	"supportFile": "./src/support/index.ts",
+	"pluginsFile": false,
+	"video": true,
+	"videosFolder": "../../dist/cypress/apps/cursorless-org-e2e/videos",
+	"screenshotsFolder": "../../dist/cypress/apps/cursorless-org-e2e/screenshots",
+	"chromeWebSecurity": false
+}

cursorless-nx/apps/cursorless-org-e2e/.eslintrc.json

@@ -0,0 +1,28 @@
+{
+	"$schema": "../../node_modules/nx/schemas/project-schema.json",
+	"sourceRoot": "apps/cursorless-org-e2e/src",
+	"projectType": "application",
+	"targets": {
+		"e2e": {
+			"executor": "@nrwl/cypress:cypress",
+			"options": {
+				"cypressConfig": "apps/cursorless-org-e2e/cypress.json",
+				"devServerTarget": "cursorless-org:serve:development"
+			},
+			"configurations": {
+				"production": {
+					"devServerTarget": "cursorless-org:serve:production"
+				}
+			}
+		},
+		"lint": {
+			"executor": "@nrwl/linter:eslint",
+			"outputs": ["{options.outputFile}"],
+			"options": {
+				"lintFilePatterns": ["apps/cursorless-org-e2e/**/*.{js,ts}"]
+			}
+		}
+	},
+	"tags": [],
+	"implicitDependencies": ["cursorless-org"]
+}

cursorless-nx/apps/cursorless-org-e2e/cypress.json

@@ -0,0 +1,4 @@
+{
+	"name": "Using fixtures to represent data",
+	"email": "[email protected]"
+}

cursorless-nx/apps/cursorless-org-e2e/project.json

@@ -0,0 +1,13 @@
+import { getGreeting } from '../support/app.po';
+
+describe('cursorless-org', () => {
+  beforeEach(() => cy.visit('/'));
+
+  it('should display welcome message', () => {
+    // Custom command example, see `../support/commands.ts` file
+    cy.login('[email protected]', 'myPassword');
+
+    // Function helper example, see `../support/app.po.ts` file
+    getGreeting().contains('Welcome cursorless-org');
+  });
+});

cursorless-nx/apps/cursorless-org-e2e/src/fixtures/example.json

@@ -0,0 +1 @@
+export const getGreeting = () => cy.get('h1');

cursorless-nx/apps/cursorless-org-e2e/src/integration/app.spec.ts

@@ -0,0 +1,33 @@
+// ***********************************************
+// This example commands.js shows you how to
+// create various custom commands and overwrite
+// existing commands.
+//
+// For more comprehensive examples of custom
+// commands please read more here:
+// https://on.cypress.io/custom-commands
+// ***********************************************
+
+// eslint-disable-next-line @typescript-eslint/no-namespace
+declare namespace Cypress {
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  interface Chainable<Subject> {
+    login(email: string, password: string): void;
+  }
+}
+//
+// -- This is a parent command --
+Cypress.Commands.add('login', (email, password) => {
+  console.log('Custom command example: Login', email, password);
+});
+//
+// -- This is a child command --
+// Cypress.Commands.add("drag", { prevSubject: 'element'}, (subject, options) => { ... })
+//
+//
+// -- This is a dual command --
+// Cypress.Commands.add("dismiss", { prevSubject: 'optional'}, (subject, options) => { ... })
+//
+//
+// -- This will overwrite an existing command --
+// Cypress.Commands.overwrite("visit", (originalFn, url, options) => { ... })

cursorless-nx/apps/cursorless-org-e2e/src/support/app.po.ts

@@ -0,0 +1,17 @@
+// ***********************************************************
+// This example support/index.js is processed and
+// loaded automatically before your test files.
+//
+// This is a great place to put global configuration and
+// behavior that modifies Cypress.
+//
+// You can change the location of this file or turn off
+// automatically serving support files with the
+// 'supportFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/configuration
+// ***********************************************************
+
+// Import commands.js using ES2015 syntax:
+import './commands';

cursorless-nx/apps/cursorless-org-e2e/src/support/commands.ts

@@ -0,0 +1,10 @@
+{
+	"extends": "../../tsconfig.base.json",
+	"compilerOptions": {
+		"sourceMap": false,
+		"outDir": "../../dist/out-tsc",
+		"allowJs": true,
+		"types": ["cypress", "node"]
+	},
+	"include": ["src/**/*.ts", "src/**/*.js"]
+}