feat: use package attributes to determine lint preset

Paul Marbach · Paul Marbach · commit f6151ed5fe0c · 2019-09-23T18:23:15.000-04:00
By checking the package that called web-scripts or eslint-config, we can determine whether we should check for React or TypeScript stuff or not. fix #56
diff --git a/packages/create-web-scripts-library/package.json b/packages/create-web-scripts-library/package.json
@@ -40,7 +40,6 @@
     "fs-extra": "^7.0.1"
   },
   "devDependencies": {
-    "@spotify/web-scripts": "^2.0.0",
     "@types/fs-extra": "^7.0.0",
     "tempy": "^0.3.0"
   },
diff --git a/packages/eslint-config/index.js b/packages/eslint-config/index.js
@@ -1,12 +1,24 @@
+const { hasConfig } = require('@spotify/web-scripts-utils');
+
+const hasReact = hasConfig([
+  { type: 'dependency', dependency: 'react' },
+  { type: 'dependency', dependency: 'react', dependencyType: 'peer' },
+]);
+const hasTypescript = hasConfig([
+  { type: 'dependency', dependency: 'typescript' },
+  { type: 'dependency', dependency: 'typescript', dependencyType: 'dev' },
+  { type: 'file', pattern: 'tsconfig.json' },
+]);
+
 module.exports = {
   extends: [
     '@spotify/eslint-config-base',
-    '@spotify/eslint-config-react',
-    '@spotify/eslint-config-typescript',
+    hasReact ? '@spotify/eslint-config-react' : null,
+    hasTypescript ? '@spotify/eslint-config-typescript' : null,
     'prettier',
-    'prettier/react',
-    'prettier/@typescript-eslint',
-  ],
+    hasReact ? 'prettier/react' : null,
+    hasTypescript ? 'prettier/@typescript-eslint' : null,
+  ].filter(s => !!s),
   parser: '@typescript-eslint/parser',
   env: {
     jest: true,
diff --git a/packages/eslint-config/package.json b/packages/eslint-config/package.json
@@ -20,6 +20,7 @@
     "@spotify/eslint-config-base": "^2.0.0",
     "@spotify/eslint-config-react": "^2.0.0",
     "@spotify/eslint-config-typescript": "^2.0.0",
+    "@spotify/web-scripts-utils": "^2.0.0",
     "@typescript-eslint/eslint-plugin": "^1.11.0",
     "@typescript-eslint/parser": "^1.11.0",
     "eslint-config-prettier": "^6.0.0",
diff --git a/packages/web-scripts-utils/.eslintignore b/packages/web-scripts-utils/.eslintignore
@@ -0,0 +1 @@
+__fixtures__
diff --git a/packages/web-scripts-utils/README.md b/packages/web-scripts-utils/README.md
@@ -0,0 +1,11 @@
+# `web-scripts-utils`
+
+> TODO: description
+
+## Usage
+
+```
+const webScriptsUtils = require('web-scripts-utils');
+
+// TODO: DEMONSTRATE API
+```
diff --git a/packages/web-scripts-utils/__fixtures__/.eslintignore b/packages/web-scripts-utils/__fixtures__/.eslintignore
@@ -0,0 +1,2 @@
+**/*.ts
+**/*.tsx
diff --git a/packages/web-scripts-utils/__fixtures__/demo-lib/package.json b/packages/web-scripts-utils/__fixtures__/demo-lib/package.json
@@ -0,0 +1,15 @@
+{
+  "name": "some-dummy-project",
+  "jest": {
+    "collectCoverageFrom": "src/**/*.ts"
+  },
+  "dependencies": {
+    "react": "*"
+  },
+  "devDependencies": {
+    "@testing-library/react": "*"
+  },
+  "peerDependencies": {
+    "styled-components": "*"
+  }
+}
diff --git a/packages/web-scripts-utils/__fixtures__/demo-lib/src/index.ts b/packages/web-scripts-utils/__fixtures__/demo-lib/src/index.ts
@@ -0,0 +1 @@
+export const a = () => '';
diff --git a/packages/web-scripts-utils/__fixtures__/demo-lib/tsconfig.json b/packages/web-scripts-utils/__fixtures__/demo-lib/tsconfig.json
@@ -0,0 +1,4 @@
+{
+  "extends": "@spotify/tsconfig/tsconfig.lib.json",
+  "include": ["src"]
+}
diff --git a/packages/web-scripts-utils/package.json b/packages/web-scripts-utils/package.json
@@ -0,0 +1,38 @@
+{
+  "name": "@spotify/web-scripts-utils",
+  "version": "2.0.0",
+  "private": true,
+  "description": "Private package which contains re-used utils within web-scripts projects",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/spotify/web-scripts.git"
+  },
+  "main": "cjs/index.js",
+  "module": "esm/index.js",
+  "types": "types",
+  "files": [
+    "cjs",
+    "esm",
+    "types"
+  ],
+  "scripts": {
+    "clean": "rm -rf cjs esm types",
+    "build": "web-scripts build",
+    "test": "web-scripts test",
+    "lint": "web-scripts lint",
+    "format": "web-scripts format",
+    "bootstrap": "$npm_execpath run clean && tsc --allowJs --outDir cjs --noEmit false --module CommonJS && tsc --declaration --isolatedModules false --outDir types --emitDeclarationOnly --noEmit false",
+    "prepublishOnly": "$npm_execpath run build",
+    "prepare": "$npm_execpath run build"
+  },
+  "dependencies": {
+    "glob": "^7.1.4",
+    "read-pkg-up": "^6.0.0"
+  },
+  "devDependencies": {
+    "@spotify/tsconfig": "^2.0.0"
+  },
+  "engines": {
+    "node": ">= 10"
+  }
+}
diff --git a/packages/web-scripts-utils/src/get-consuming-root.ts b/packages/web-scripts-utils/src/get-consuming-root.ts
@@ -0,0 +1,5 @@
+import { resolve } from 'path';
+
+// The ROOT folder of the consuming package,
+// aka where the user is using this package from.
+export const getConsumingRoot = () => resolve(process.cwd());
diff --git a/packages/web-scripts-utils/src/has-config.test.ts b/packages/web-scripts-utils/src/has-config.test.ts
@@ -0,0 +1,89 @@
+jest.mock('./get-consuming-root');
+
+import path from 'path';
+import { hasConfig } from './has-config';
+
+const { getConsumingRoot } = require.requireMock('./get-consuming-root');
+
+describe('hasConfig', () => {
+  beforeEach(() => {
+    getConsumingRoot.mockReturnValue(
+      path.join(__dirname, '..', '__fixtures__', 'demo-lib'),
+    );
+  });
+  it('works for a file', () => {
+    expect(hasConfig([{ type: 'file', pattern: 'tsconfig.json' }])).toBe(true);
+  });
+
+  it('works for a package.json property', () => {
+    expect(hasConfig([{ type: 'package.json', property: 'name' }])).toBe(true);
+  });
+
+  it('works for a nested package.json property', () => {
+    expect(
+      hasConfig([
+        { type: 'package.json', property: 'jest.collectCoverageFrom' },
+      ]),
+    ).toBe(true);
+  });
+
+  it('works for a dependency', () => {
+    expect(hasConfig([{ type: 'dependency', dependency: 'react' }])).toBe(true);
+  });
+
+  it('works for a dev dependency', () => {
+    expect(
+      hasConfig([
+        {
+          type: 'dependency',
+          dependency: '@testing-library/react',
+          dependencyType: 'dev',
+        },
+      ]),
+    ).toBe(true);
+  });
+
+  it('works for a peer dependency', () => {
+    expect(
+      hasConfig([
+        {
+          type: 'dependency',
+          dependency: 'styled-components',
+          dependencyType: 'peer',
+        },
+      ]),
+    ).toBe(true);
+  });
+
+  it('works when some fail and some succeed', () => {
+    expect(
+      hasConfig([
+        {
+          type: 'dependency',
+          dependency: 'react',
+        },
+        {
+          type: 'dependency',
+          dependency: 'react',
+          dependencyType: 'peer',
+        },
+      ]),
+    ).toBe(true);
+  });
+
+  it('fails when all fail', () => {
+    expect(
+      hasConfig([
+        {
+          type: 'dependency',
+          dependency: 'angular',
+        },
+        {
+          type: 'dependency',
+          dependency: 'angular',
+          dependencyType: 'peer',
+        },
+      ]),
+    ).toBe(false);
+  });
+});
diff --git a/packages/web-scripts-utils/src/has-config.ts b/packages/web-scripts-utils/src/has-config.ts
@@ -0,0 +1,52 @@
+import glob from 'glob';
+import readPkgUp from 'read-pkg-up';
+
+import { getConsumingRoot } from './get-consuming-root';
+import { hasKeyInObj } from './has-key-in-obj';
+
+const getDependencyTypePath = (
+  dependency: string,
+  type?: 'dev' | 'peer',
+): string => {
+  switch (type) {
+    case 'dev':
+      return `devDependencies.${dependency}`;
+    case 'peer':
+      return `peerDependencies.${dependency}`;
+    default:
+      return `dependencies.${dependency}`;
+  }
+};
+
+// this function can be used to determine whether a config exists,
+// either in package.json or as a file.
+export const hasConfig = (
+  sources: (
+    | { type: 'file'; pattern: string }
+    | { type: 'package.json'; property: string }
+    | {
+        type: 'dependency';
+        dependency: string;
+        dependencyType?: 'peer' | 'dev';
+      })[],
+): boolean => {
+  const { path: pkgPath, package: pkg } = readPkgUp.sync({
+    cwd: getConsumingRoot(),
+  }) || { package: {}, path: getConsumingRoot() };
+  const root = pkgPath.slice(0, pkgPath.length - '/package.json'.length);
+  return sources.some(source => {
+    switch (source.type) {
+      case 'file':
+        return !!glob.sync(source.pattern, { cwd: root }).length;
+      case 'package.json':
+        return hasKeyInObj(source.property, pkg);
+      case 'dependency':
+        return hasKeyInObj(
+          getDependencyTypePath(source.dependency, source.dependencyType),
+          pkg,
+        );
+      default:
+        return false;
+    }
+  });
+};
diff --git a/packages/web-scripts-utils/src/has-key-in-obj.test.ts b/packages/web-scripts-utils/src/has-key-in-obj.test.ts
@@ -0,0 +1,23 @@
+import { hasKeyInObj } from './has-key-in-obj';
+
+describe('hasKeyInObj', () => {
+  it('works when the key is defined', () => {
+    expect(hasKeyInObj('a', { a: 1, b: 2 })).toBe(true);
+  });
+
+  it('works when the key is not defined', () => {
+    expect(hasKeyInObj('c', { a: 1, b: 2 })).toBe(false);
+  });
+
+  it('works when the key is nested and defined', () => {
+    expect(hasKeyInObj('c.foo', { a: 1, b: 2, c: { foo: 'bar' } })).toBe(true);
+  });
+
+  it('works when the key is nested and undefined', () => {
+    expect(hasKeyInObj('c.baz', { a: 1, b: 2, c: { foo: 'bar' } })).toBe(false);
+  });
+
+  it('works when the key is nested and undefined early', () => {
+    expect(hasKeyInObj('d.baz', { a: 1, b: 2, c: { foo: 'bar' } })).toBe(false);
+  });
+});
diff --git a/packages/web-scripts-utils/src/has-key-in-obj.ts b/packages/web-scripts-utils/src/has-key-in-obj.ts
@@ -0,0 +1,14 @@
+export const hasKeyInObj = (
+  key: string,
+  obj: { [s: string]: any },
+): boolean => {
+  const [k, ...restOfK] = key.split('.');
+  if (restOfK.length === 0) {
+    return Object.keys(obj).some(ok => ok === k);
+  }
+  const nextObj = obj[k];
+  if (!(nextObj instanceof Object)) {
+    return false;
+  }
+  return hasKeyInObj(restOfK.join('.'), nextObj);
+};
diff --git a/packages/web-scripts-utils/src/index.ts b/packages/web-scripts-utils/src/index.ts
@@ -0,0 +1,2 @@
+export { getConsumingRoot } from './get-consuming-root';
+export { hasConfig } from './has-config';
diff --git a/packages/web-scripts-utils/tsconfig.json b/packages/web-scripts-utils/tsconfig.json
@@ -0,0 +1,11 @@
+{
+  "extends": "@spotify/tsconfig/tsconfig.lib.json",
+  "include": ["src"],
+  "compilerOptions": {
+    "incremental": true,
+    "isolatedModules": false,
+    "noEmit": true,
+    "declaration": false,
+    "jsx": "preserve"
+  }
+}
diff --git a/packages/web-scripts/.eslintignore b/packages/web-scripts/.eslintignore
@@ -0,0 +1 @@
+__fixtures__
diff --git a/packages/web-scripts/package.json b/packages/web-scripts/package.json
@@ -36,6 +36,7 @@
     "@spotify/eslint-config": "^2.0.0",
     "@spotify/prettier-config": "^2.0.0",
     "@spotify/tsconfig": "^2.0.0",
+    "@spotify/web-scripts-utils": "^2.0.0",
     "@types/cross-spawn": "^6.0.0",
     "@types/debug": "^4.1.2",
     "@types/jest": "^24.0.11",
@@ -47,18 +48,15 @@
     "cz-conventional-changelog": "^2.1.0",
     "debug": "^4.1.1",
     "eslint": "^5.16.0",
-    "glob": "^7.1.4",
     "jest": "^24.5.0",
     "jest-junit": "^6.3.0",
     "lint-staged": "^8.1.5",
     "prettier": "^1.18.2",
-    "read-pkg-up": "^6.0.0",
     "semantic-release": "^15.13.17",
     "ts-jest": "^24.0.2",
     "typescript": "^3.4.3"
   },
   "devDependencies": {
-    "@types/glob": "^7.1.1",
     "@types/rimraf": "^2.0.2",
     "@types/tempy": "^0.2.0",
     "object.fromentries": "^2.0.0",
diff --git a/packages/web-scripts/src/Paths.ts b/packages/web-scripts/src/Paths.ts
@@ -1,8 +1,9 @@
 import { join } from 'path';
+import { getConsumingRoot } from '@spotify/web-scripts-utils';
 
 // The ROOT folder of the consuming package, aka where the user is using this
 // package from.
-export const CONSUMING_ROOT = join(process.cwd());
+export const CONSUMING_ROOT = getConsumingRoot();
 
 // This tool's ROOT folder.
 export const THIS_ROOT = join(__dirname, '..');
diff --git a/packages/web-scripts/src/Tasks/FormatTask.ts b/packages/web-scripts/src/Tasks/FormatTask.ts
@@ -1,10 +1,10 @@
 import { default as Debug } from 'debug';
 import { default as spawn } from 'cross-spawn';
 import { SpawnSyncReturns } from 'child_process';
+import { hasConfig } from '@spotify/web-scripts-utils';
 
 import { FormatTaskDesc } from '../SharedTypes';
 import { PRETTIER_CONFIG } from '../Paths';
-import { hasConfig } from '../hasConfig';
 
 const dbg = Debug('web-scripts:format'); // eslint-disable-line new-cap
 
diff --git a/packages/web-scripts/src/Tasks/LintTask.ts b/packages/web-scripts/src/Tasks/LintTask.ts
@@ -1,9 +1,9 @@
 import { default as spawn } from 'cross-spawn-promise';
 import { default as Debug } from 'debug';
+import { hasConfig } from '@spotify/web-scripts-utils';
 
 import { LintTaskDesc } from '../SharedTypes';
 import { CONSUMING_ROOT, ESLINT_CONFIG } from '../Paths';
-import { hasConfig } from '../hasConfig';
 
 const dbg = Debug('web-scripts:lint'); // eslint-disable-line new-cap
 
diff --git a/packages/web-scripts/src/Tasks/TestTask.ts b/packages/web-scripts/src/Tasks/TestTask.ts
diff --git a/packages/web-scripts/src/hasConfig.ts b/packages/web-scripts/src/hasConfig.ts

-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +{
 +  "extends": "@spotify/tsconfig/tsconfig.lib.json",
 +  "include": ["src"]
 +}