Merge pull request #1525 from github/koesie10/prettier

Add Prettier

Author: koesie10

.gitattributes

@@ -23,3 +23,6 @@ CHANGELOG.md                merge=union
 # Mark some JSON files containing test data as generated so they are not included
 # as part of diffs or language statistics.
 extensions/ql-vscode/src/stories/remote-queries/data/*.json     linguist-generated
+
+# Always use LF line endings, also on Windows
+* text=auto eol=lf

.vscode/extensions.json

@@ -5,7 +5,7 @@
   "recommendations": [
     "amodio.tsl-problem-matcher",
     "dbaeumer.vscode-eslint",
-    "eternalphane.tsfmt-vscode"
+    "esbenp.prettier-vscode"
   ],
   // List of extensions recommended by VS Code that should not be recommended for users of this workspace.
   "unwantedRecommendations": []

.vscode/settings.json

@@ -36,5 +36,13 @@
   "typescript.preferences.quoteStyle": "single",
   "javascript.preferences.quoteStyle": "single",
   "editor.wordWrapColumn": 100,
-  "jest.rootPath": "./extensions/ql-vscode"
+  "jest.rootPath": "./extensions/ql-vscode",
+  "[typescript]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+  },
+  "[typescriptreact]": {
+    "editor.defaultFormatter": "esbenp.prettier-vscode",
+    "editor.formatOnSave": true,
+  },
 }

extensions/ql-vscode/.eslintrc.js

@@ -10,7 +10,12 @@ module.exports = {
     node: true,
     es6: true,
   },
-  extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended", "plugin:jest-dom/recommended"],
+  extends: [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:jest-dom/recommended",
+    "plugin:prettier/recommended"
+  ],
   rules: {
     "@typescript-eslint/no-use-before-define": 0,
     "@typescript-eslint/no-unused-vars": [
@@ -27,11 +32,7 @@ module.exports = {
     "@typescript-eslint/no-explicit-any": "off",
     "@typescript-eslint/no-floating-promises": [ "error", { ignoreVoid: true } ],
     "prefer-const": ["warn", { destructuring: "all" }],
-    indent: "off",
-    "@typescript-eslint/indent": "off",
     "@typescript-eslint/no-throw-literal": "error",
     "no-useless-escape": 0,
-    semi: 2,
-    quotes: ["warn", "single"]
   },
 };

extensions/ql-vscode/.git-blame-ignore-revs

@@ -0,0 +1,5 @@
+# Run this command to always ignore formatting commits in `git blame`
+# git config blame.ignoreRevsFile .git-blame-ignore-revs
+
+# Formatted all code using Prettier instead of tsfmt
+ebcdf8ad0bb5bcb3efa679211709671716b892ba

extensions/ql-vscode/.prettierignore

@@ -0,0 +1,6 @@
+.vscode-test/
+node_modules/
+out/
+
+# Include the Storybook config
+!.storybook

extensions/ql-vscode/.prettierrc

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

extensions/ql-vscode/.storybook/main.ts

@@ -1,20 +1,17 @@
-import type { StorybookConfig } from '@storybook/core-common';
+import type { StorybookConfig } from "@storybook/core-common";
 
 const config: StorybookConfig = {
-  stories: [
-    '../src/**/*.stories.mdx',
-    '../src/**/*.stories.@(js|jsx|ts|tsx)'
-  ],
+  stories: ["../src/**/*.stories.mdx", "../src/**/*.stories.@(js|jsx|ts|tsx)"],
   addons: [
-    '@storybook/addon-links',
-    '@storybook/addon-essentials',
-    '@storybook/addon-interactions',
-    './vscode-theme-addon/preset.ts',
+    "@storybook/addon-links",
+    "@storybook/addon-essentials",
+    "@storybook/addon-interactions",
+    "./vscode-theme-addon/preset.ts",
   ],
-  framework: '@storybook/react',
+  framework: "@storybook/react",
   core: {
-    builder: '@storybook/builder-webpack5'
-  }
+    builder: "@storybook/builder-webpack5",
+  },
 };
 
 module.exports = config;

extensions/ql-vscode/.storybook/manager.ts

@@ -1,5 +1,5 @@
-import { addons } from '@storybook/addons';
-import { themes } from '@storybook/theming';
+import { addons } from "@storybook/addons";
+import { themes } from "@storybook/theming";
 
 addons.setConfig({
   theme: themes.dark,

extensions/ql-vscode/.storybook/preview.ts

@@ -1,13 +1,13 @@
-import { themes } from '@storybook/theming';
-import { action } from '@storybook/addon-actions';
+import { themes } from "@storybook/theming";
+import { action } from "@storybook/addon-actions";
 
 // Allow all stories/components to use Codicons
-import '@vscode/codicons/dist/codicon.css';
+import "@vscode/codicons/dist/codicon.css";
 
 // https://storybook.js.org/docs/react/configure/overview#configure-story-rendering
 export const parameters = {
   // All props starting with `on` will automatically receive an action as a prop
-  actions: { argTypesRegex: '^on[A-Z].*' },
+  actions: { argTypesRegex: "^on[A-Z].*" },
   // All props matching these names will automatically get the correct control
   controls: {
     matchers: {
@@ -22,10 +22,10 @@ export const parameters = {
   backgrounds: {
     // The background is injected by our theme CSS files
     disable: true,
-  }
+  },
 };
 
 (window as any).acquireVsCodeApi = () => ({
-  postMessage: action('post-vscode-message'),
-  setState: action('set-vscode-state'),
+  postMessage: action("post-vscode-message"),
+  setState: action("set-vscode-state"),
 });