Merge pull request #245 from proto-graphql/izumin5210/linter-and-formatter

Define custom configs for ESLint and  Prettier

Author: izumin5210

.eslintignore

@@ -0,0 +1,113 @@
+/** @type {import("eslint").ESLint.ConfigData} */
+const config = {
+  root: true,
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    sourceType: "module",
+    tsconfigRootDir: __dirname,
+    project: [
+      "./tsconfig.eslint.json",
+      "./packages/*/tsconfig.json",
+      "./packages/@proto-graphql/*/tsconfig.json",
+      "./packages/@proto-nexus/*/tsconfig.json",
+      "./e2e/tsconfig.eslint.json",
+      "./e2e/tests/*/tsconfig.json",
+    ],
+  },
+  ignorePatterns: [
+    "packages/@testapis/**",
+    "**/__generated__/**",
+    "**/coverage/**",
+    "**/lib/**",
+    "**/module/**",
+    "**/tmp/**",
+  ],
+  env: {
+    node: true,
+  },
+  extends: [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "prettier",
+    // 'plugin:import/recommended', // use only `import/order`
+    // 'plugin:import/typescript', // Not necessary for `import/order` use only
+  ],
+  plugins: ["@typescript-eslint", "import", "unused-imports"],
+  rules: {
+    // eslint: recommended rules
+    "no-undef": "off",
+
+    // eslint: additional rules
+    "prefer-const": "error",
+    eqeqeq: ["error", "smart"],
+    "no-console": "error",
+    "no-restricted-syntax": [
+      "error",
+      {
+        selector: "TSEnumDeclaration",
+        message:
+          "Don't use TypeScript enums. Use object literal with `as const` instead. See https://typescriptbook.jp/reference/values-types-variables/enum/enum-problems-and-alternatives-to-enums",
+      },
+    ],
+
+    // typescript-eslint: recommended rules
+    "@typescript-eslint/no-unused-vars": [
+      "warn",
+      {
+        varsIgnorePattern: "^_",
+        argsIgnorePattern: "^_",
+        ignoreRestSiblings: true,
+      },
+    ],
+    // TODO: Change to "error" when all warnings are resolved
+    "@typescript-eslint/no-explicit-any": "off",
+
+    // typescript-eslint: additional rules
+    "@typescript-eslint/explicit-member-accessibility": [
+      "error",
+      {
+        overrides: {
+          constructors: "no-public",
+          parameterProperties: "no-public",
+          accessors: "no-public",
+        },
+      },
+    ],
+    "@typescript-eslint/no-redeclare": "error",
+
+    // import
+    "import/order": [
+      "error",
+      {
+        groups: [
+          "builtin",
+          "external",
+          ["internal", "parent", "sibling", "index"],
+          "object",
+          "type",
+        ],
+        "newlines-between": "always",
+        alphabetize: {
+          order: "asc",
+        },
+      },
+    ],
+
+    // unused-imports
+    "unused-imports/no-unused-imports": "error",
+  },
+  reportUnusedDisableDirectives: true,
+  overrides: [
+    {
+      files: ["{test,__test__}/**", "**/*.{spec,test}.{,m,c}{j,t}s{,x}"],
+      plugins: ["jest"],
+      env: {
+        jest: true,
+        "jest/globals": true,
+      },
+      extends: ["plugin:jest/recommended"],
+    },
+  ],
+};
+
+module.exports = config;

.eslintrc.js

@@ -4,21 +4,16 @@ on: [push, pull_request]
 
 jobs:
   test:
-
     runs-on: ubuntu-latest
-
     steps:
     - uses: actions/checkout@v2
       with:
-        fetch-depth: 0
         submodules: true
     - name: Use Node.js 14.x
       uses: actions/setup-node@v1
       with:
         node-version: 14.x
     - run: yarn --frozen-lockfile
-    - run: yarn lint:ci
-    - run: yarn build
     - run: yarn test
     - name: Coveralls
       uses: coverallsapp/github-action@v1.1.2
@@ -27,11 +22,28 @@ jobs:
         path-to-lcov: packages/protoc-gen-nexus/coverage/lcov.info
         base-path: packages/protoc-gen-nexus
 
+  lint:
+    if: github.event_name == 'pull_request'
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+        submodules: true
+    - name: Use Node.js 14.x
+      uses: actions/setup-node@v1
+      with:
+        node-version: 14.x
+    - run: yarn --frozen-lockfile
+    - run: yarn lint
+      env:
+        NODE_OPTIONS: "--max_old_space_size=4096"
+    - run: yarn format
+    - name: check generated code is up to date
+      run: git diff --exit-code
 
   test-e2e:
-
     runs-on: ubuntu-latest
-
     steps:
     - uses: actions/checkout@v2
       with:

.github/workflows/ci.yml

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+yarn pre-commit

.husky/pre-commit

@@ -0,0 +1,3 @@
+module.exports = {
+  "*.{mjs,js,jsx,mts,ts,tsx}": ["prettier --write", "eslint --fix"],
+};

.lintstagedrc.cjs

@@ -1,3 +1,10 @@
-lib/
 tmp/
+coverage/
+
+# build artifacts
+lib/
+module/
+
+# auto generated files
 __generated__/
+/packages/@testapis/

.prettierignore

@@ -0,0 +1,15 @@
+/** @type {import("prettier").Options} */
+module.exports = {
+  printWidth: 80,
+  tabWidth: 2,
+  useTabs: false,
+  semi: true,
+  singleQuote: false,
+  quoteProps: "as-needed",
+  jsxSingleQuote: false,
+  trailingComma: "es5",
+  bracketSpacing: true,
+  bracketSameLine: false,
+  arrowParens: "always",
+  endOfLine: "lf",
+};

.prettierrc.js

@@ -7,14 +7,20 @@ import { basename, join, relative } from "path";
 import { promisify } from "util";
 
 const exec = promisify(_exec);
-const header = `// Code generated by ${basename(import.meta.url)}. DO NOT EDIT.`;
+const header = `// Code generated by ${basename(
+  import.meta.url
+)}. DO NOT EDIT.`;
 const testsDir = "tests";
 
 /**
  * @param {{ target: "nexus" | "pothos", proto: { package: String, lib: String } } opts
  */
 function getTestPath(opts) {
-  return `${testsDir}/${[opts.target, opts.proto.package.replace("/", "-"), opts.proto.lib].join("--")}`;
+  return `${testsDir}/${[
+    opts.target,
+    opts.proto.package.replace("/", "-"),
+    opts.proto.lib,
+  ].join("--")}`;
 }
 
 /**
@@ -42,14 +48,27 @@ async function setupTest(opts) {
       relative(path, "./src"),
       relative(
         path,
-        [testsDir, "__generated__", opts.target, opts.proto.lib, "testapis", ...opts.proto.package.split("/")].join("/")
+        [
+          testsDir,
+          "__generated__",
+          opts.target,
+          opts.proto.lib,
+          "testapis",
+          ...opts.proto.package.split("/"),
+        ].join("/")
       ),
     ].map((p) => `${p}/**/*`),
   };
 
-  await writeFile(tsconfigPath, `${header}\n${JSON.stringify(tsconfig, undefined, 2)}`, "utf-8");
+  await writeFile(
+    tsconfigPath,
+    `${header}\n${JSON.stringify(tsconfig, undefined, 2)}`,
+    "utf-8"
+  );
 
-  await exec(`yarn ts-node --transpile-only --require tsconfig-paths/register --project ${tsconfigPath} ${schemaPath}`);
+  await exec(
+    `yarn ts-node --transpile-only --require tsconfig-paths/register --project ${tsconfigPath} ${schemaPath}`
+  );
 }
 
 async function setupTests() {
@@ -73,7 +92,9 @@ async function setupTests() {
 
 async function setupProtoNexus() {
   await rm(join(testsDir, "__generated__"), { recursive: true, force: true });
-  await exec(`buf generate ${join("..", "packages", "@testapis", "proto", "src")}`);
+  await exec(
+    `buf generate ${join("..", "packages", "@testapis", "proto", "src")}`
+  );
 }
 
 async function main() {

e2e/setupTests.mjs

@@ -1,7 +1,14 @@
-import { makeSchema } from "nexus";
 import * as path from "path";
 
-export function makeTestSchema({ rootDir, types }: { rootDir: string; types: any }) {
+import { makeSchema } from "nexus";
+
+export function makeTestSchema({
+  rootDir,
+  types,
+}: {
+  rootDir: string;
+  types: any;
+}) {
   const schema = makeSchema({
     types,
     outputs: {

e2e/src/makeTestSchema.ts

@@ -1,8 +1,19 @@
 import { mkdirSync, writeFileSync } from "fs";
-import { GraphQLSchema, printSchema } from "graphql";
 import { join } from "path";
 
-export function printGraphqlSchema({ rootDir, schema }: { rootDir: string; schema: GraphQLSchema }) {
+import { GraphQLSchema, printSchema } from "graphql";
+
+export function printGraphqlSchema({
+  rootDir,
+  schema,
+}: {
+  rootDir: string;
+  schema: GraphQLSchema;
+}) {
   mkdirSync(join(rootDir, "__generated__"), { recursive: true });
-  writeFileSync(join(rootDir, "__generated__", "schema.graphql"), printSchema(schema), "utf-8");
+  writeFileSync(
+    join(rootDir, "__generated__", "schema.graphql"),
+    printSchema(schema),
+    "utf-8"
+  );
 }