presetter-preset-react 3.1.0 → 3.3.0

package/README.md

@@ -4,14 +4,14 @@
 
 🏄🏻 _A collection of opinionated configurations for a React project in typescript for presetter_
 
-•   [Quick Start](#quick-start)   •   [Project Structure](#project-structure)   •   [Customisation](#customisation)   •   [Scripts](#script-template-summary)   •
+•   [Quick Start](#quick-start)   •   [Project Structure](#project-structure)   •   [Customization](#customization)   •   [Scripts](#script-template-summary)   •
 
 [![npm](https://img.shields.io/npm/v/presetter-preset-react?style=flat-square)](https://github.com/alvis/presetter/releases)
 [![build](https://img.shields.io/github/workflow/status/alvis/presetter/code%20test?style=flat-square)](https://github.com/alvis/presetter/actions)
 [![maintainability](https://img.shields.io/codeclimate/maintainability/alvis/presetter?style=flat-square)](https://codeclimate.com/github/alvis/presetter/maintainability)
 [![coverage](https://img.shields.io/codeclimate/coverage/alvis/presetter?style=flat-square)](https://codeclimate.com/github/alvis/presetter/test_coverage)
 [![security](https://img.shields.io/snyk/vulnerabilities/github/alvis/presetter/packages/preset-react/package.json.svg?style=flat-square)](https://snyk.io/test/github/alvis/presetter?targetFile=packages/preset-react/package.json&style=flat-square)
-[![dependencies](https://img.shields.io/david/alvis/presetter?path=packages/preset-react&style=flat-square)](https://david-dm.org/alvis/presetter?path=packages/preset-react)
+[![dependencies](https://img.shields.io/librariesio/release/npm/presetter-preset-react?style=flat-square)](https://libraries.io/npm/presetter-preset-react)
 [![license](https://img.shields.io/github/license/alvis/presetter.svg?style=flat-square)](https://github.com/alvis/presetter/blob/master/LICENSE)
 
 </div>
@@ -49,13 +49,13 @@ After installation, your project file structure should resemble the following or
 
 Implement your business logic under `source` and prepare tests under `spec`. The `.d.ts` files are handy type definitions for you to import `.css` or image files in typescript.
 
-**TIPS** You can always change the source directory to other (e.g. src) by setting the `source` variable in `.presetterrc.json`. See the [customisation](https://github.com/alvis/presetter/blob/master/packages/preset-react#customisation) section below for more details.
+**TIPS** You can always change the source directory to other (e.g. src) by setting the `source` variable in `.presetterrc.json`. See the [customization](https://github.com/alvis/presetter/blob/master/packages/preset-react#customization) section below for more details.
 
 ```
 (root)
  ├─ .eslintrc.json
  ├─ .git
- ├─ .preseterrc.json
+ ├─ .presetterrc.json
  ├─ node_modules
  ├─ source
  │   ├─ <folders>
@@ -71,10 +71,10 @@ Implement your business logic under `source` and prepare tests under `spec`. The
  └─ tsconfig.json
 ```
 
-## Customisation
+## Customization
 
 By default, this preset exports a handy configuration set for a React project written in typescript.
-But you can further customise (either extending or replacing) the configuration by specifying the change in the config file (`.presetterrc` or `.presetterrc.json`).
+But you can further customize (either extending or replacing) the configuration by specifying the change in the config file (`.presetterrc` or `.presetterrc.json`).
 
 These settings are available in the `config` field in the config file. For directories, the setting is specified in the `variable` field.
 

package/configs/eslint.yaml

@@ -12,9 +12,3 @@ rules:
       contexts:
         - FunctionDeclaration:has(BlockStatement > ReturnStatement:not([argument.type='JSXElement']))
         - ArrowFunctionExpression:has(BlockStatement > ReturnStatement:not([argument.type='JSXElement']))
-overrides:
-  - files:
-      - '**/__tests__/**/*.[jt]sx'
-      - '**/?(*.)+(spec|test).[jt]sx'
-    extends:
-      - plugin:testing-library/react

package/lib/index.js

@@ -1,86 +1,37 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
+Object.defineProperty(exports, "__esModule", { value: true });
 exports.DEFAULT_VARIABLE = void 0;
-exports.default = _default;
-
-var _path = require("path");
-
-/*
- *                            *** MIT LICENSE ***
- * -------------------------------------------------------------------------
- * This code may be modified and distributed under the MIT license.
- * See the LICENSE file for details.
- * -------------------------------------------------------------------------
- *
- * @summary   Preset for a React project
- *
- * @author    Alvis HT Tang <alvis@hilbert.space>
- * @license   MIT
- * @copyright Copyright (c) 2021 - All Rights Reserved.
- * -------------------------------------------------------------------------
- */
-// paths to the template directory
-const TEMPLATES = (0, _path.resolve)(__dirname, '..', 'templates');
-const CONFIGS = (0, _path.resolve)(__dirname, '..', 'configs');
-/** config for this preset */
-
-const DEFAULT_VARIABLE = {
-  source: 'source',
-  types: 'types',
-  output: 'lib'
+const path_1 = require("path");
+const TEMPLATES = (0, path_1.resolve)(__dirname, '..', 'templates');
+const CONFIGS = (0, path_1.resolve)(__dirname, '..', 'configs');
+exports.DEFAULT_VARIABLE = {
+    source: 'source',
+    types: 'types',
+    output: 'lib',
 };
-exports.DEFAULT_VARIABLE = DEFAULT_VARIABLE;
 const IMAGE_TYPE = 'image.d.ts';
 const STYLE_TYPE = 'style.d.ts';
-
-const template = ({
-  custom: {
-    variable: {
-      types
-    }
-  }
-}) => ({
-  '.eslintrc.json': (0, _path.resolve)(TEMPLATES, 'eslintrc.yaml'),
-  'tsconfig.json': (0, _path.resolve)(TEMPLATES, 'tsconfig.yaml'),
-  [(0, _path.join)(types, IMAGE_TYPE)]: (0, _path.resolve)(TEMPLATES, IMAGE_TYPE),
-  [(0, _path.join)(types, STYLE_TYPE)]: (0, _path.resolve)(TEMPLATES, STYLE_TYPE)
+const template = ({ custom: { variable: { types }, }, }) => ({
+    '.eslintrc.json': (0, path_1.resolve)(TEMPLATES, 'eslintrc.yaml'),
+    'tsconfig.json': (0, path_1.resolve)(TEMPLATES, 'tsconfig.yaml'),
+    [(0, path_1.join)(types, IMAGE_TYPE)]: (0, path_1.resolve)(TEMPLATES, IMAGE_TYPE),
+    [(0, path_1.join)(types, STYLE_TYPE)]: (0, path_1.resolve)(TEMPLATES, STYLE_TYPE),
 });
-
-const noSymlinks = ({
-  custom: {
-    variable: {
-      types
-    }
-  }
-}) => [(0, _path.join)(types, IMAGE_TYPE), (0, _path.join)(types, STYLE_TYPE)];
-
+const noSymlinks = ({ custom: { variable: { types }, }, }) => [(0, path_1.join)(types, IMAGE_TYPE), (0, path_1.join)(types, STYLE_TYPE)];
 const supplementaryConfig = {
-  eslint: (0, _path.resolve)(CONFIGS, 'eslint.yaml'),
-  gitignore: ({
-    custom: {
-      variable: {
-        types
-      }
-    }
-  }) => [(0, _path.join)('/', types, IMAGE_TYPE), (0, _path.join)('/', types, STYLE_TYPE)],
-  jest: (0, _path.resolve)(CONFIGS, 'jest.yaml'),
-  lintstaged: (0, _path.resolve)(CONFIGS, 'lintstaged.yaml'),
-  rollup: (0, _path.resolve)(CONFIGS, 'rollup.yaml')
+    eslint: (0, path_1.resolve)(CONFIGS, 'eslint.yaml'),
+    gitignore: ({ custom: { variable: { types }, }, }) => [(0, path_1.join)('/', types, IMAGE_TYPE), (0, path_1.join)('/', types, STYLE_TYPE)],
+    jest: (0, path_1.resolve)(CONFIGS, 'jest.yaml'),
+    lintstaged: (0, path_1.resolve)(CONFIGS, 'lintstaged.yaml'),
+    rollup: (0, path_1.resolve)(CONFIGS, 'rollup.yaml'),
 };
-/**
- * get the list of templates provided by this preset
- * @returns list of preset templates
- */
-
-async function _default() {
-  return {
-    template,
-    noSymlinks,
-    supplementaryConfig,
-    variable: DEFAULT_VARIABLE
-  };
+async function default_1() {
+    return {
+        template,
+        noSymlinks,
+        supplementaryConfig,
+        variable: exports.DEFAULT_VARIABLE,
+    };
 }
-//# sourceMappingURL=index.js.map
+exports.default = default_1;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zb3VyY2UvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7O0FBZUEsK0JBQXFDO0FBS3JDLE1BQU0sU0FBUyxHQUFHLElBQUEsY0FBTyxFQUFDLFNBQVMsRUFBRSxJQUFJLEVBQUUsV0FBVyxDQUFDLENBQUM7QUFDeEQsTUFBTSxPQUFPLEdBQUcsSUFBQSxjQUFPLEVBQUMsU0FBUyxFQUFFLElBQUksRUFBRSxTQUFTLENBQUMsQ0FBQztBQW9CdkMsUUFBQSxnQkFBZ0IsR0FBYTtJQUN4QyxNQUFNLEVBQUUsUUFBUTtJQUNoQixLQUFLLEVBQUUsT0FBTztJQUNkLE1BQU0sRUFBRSxLQUFLO0NBQ2QsQ0FBQztBQUVGLE1BQU0sVUFBVSxHQUFHLFlBQVksQ0FBQztBQUNoQyxNQUFNLFVBQVUsR0FBRyxZQUFZLENBQUM7QUFFaEMsTUFBTSxRQUFRLEdBQTRCLENBQUMsRUFDekMsTUFBTSxFQUFFLEVBQ04sUUFBUSxFQUFFLEVBQUUsS0FBSyxFQUFFLEdBQ3BCLEdBQ0YsRUFBRSxFQUFFLENBQUMsQ0FBQztJQUVMLGdCQUFnQixFQUFFLElBQUEsY0FBTyxFQUFDLFNBQVMsRUFBRSxlQUFlLENBQUM7SUFDckQsZUFBZSxFQUFFLElBQUEsY0FBTyxFQUFDLFNBQVMsRUFBRSxlQUFlLENBQUM7SUFDcEQsQ0FBQyxJQUFBLFdBQUksRUFBQyxLQUFLLEVBQUUsVUFBVSxDQUFDLENBQUMsRUFBRSxJQUFBLGNBQU8sRUFBQyxTQUFTLEVBQUUsVUFBVSxDQUFDO0lBQ3pELENBQUMsSUFBQSxXQUFJLEVBQUMsS0FBSyxFQUFFLFVBQVUsQ0FBQyxDQUFDLEVBQUUsSUFBQSxjQUFPLEVBQUMsU0FBUyxFQUFFLFVBQVUsQ0FBQztDQUUxRCxDQUFDLENBQUM7QUFFSCxNQUFNLFVBQVUsR0FBOEIsQ0FBQyxFQUM3QyxNQUFNLEVBQUUsRUFDTixRQUFRLEVBQUUsRUFBRSxLQUFLLEVBQUUsR0FDcEIsR0FDRixFQUFFLEVBQUUsQ0FBQyxDQUFDLElBQUEsV0FBSSxFQUFDLEtBQUssRUFBRSxVQUFVLENBQUMsRUFBRSxJQUFBLFdBQUksRUFBQyxLQUFLLEVBQUUsVUFBVSxDQUFDLENBQUMsQ0FBQztBQUV6RCxNQUFNLG1CQUFtQixHQUF1QztJQUM5RCxNQUFNLEVBQUUsSUFBQSxjQUFPLEVBQUMsT0FBTyxFQUFFLGFBQWEsQ0FBQztJQUN2QyxTQUFTLEVBQUUsQ0FBQyxFQUNWLE1BQU0sRUFBRSxFQUNOLFFBQVEsRUFBRSxFQUFFLEtBQUssRUFBRSxHQUNwQixHQUNGLEVBQUUsRUFBRSxDQUFDLENBQUMsSUFBQSxXQUFJLEVBQUMsR0FBRyxFQUFFLEtBQUssRUFBRSxVQUFVLENBQUMsRUFBRSxJQUFBLFdBQUksRUFBQyxHQUFHLEVBQUUsS0FBSyxFQUFFLFVBQVUsQ0FBQyxDQUFDO0lBQ2xFLElBQUksRUFBRSxJQUFBLGNBQU8sRUFBQyxPQUFPLEVBQUUsV0FBVyxDQUFDO0lBQ25DLFVBQVUsRUFBRSxJQUFBLGNBQU8sRUFBQyxPQUFPLEVBQUUsaUJBQWlCLENBQUM7SUFDL0MsTUFBTSxFQUFFLElBQUEsY0FBTyxFQUFDLE9BQU8sRUFBRSxhQUFhLENBQUM7Q0FDeEMsQ0FBQztBQU1hLEtBQUs7SUFDbEIsT0FBTztRQUNMLFFBQVE7UUFDUixVQUFVO1FBQ1YsbUJBQW1CO1FBQ25CLFFBQVEsRUFBRSx3QkFBZ0I7S0FDM0IsQ0FBQztBQUNKLENBQUM7QUFQRCw0QkFPQyJ9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "presetter-preset-react",
-  "version": "3.1.0",
+  "version": "3.3.0",
   "description": "An opinionated presetter preset for a React project",
   "keywords": [
     "presetter",
@@ -30,12 +30,11 @@
     "watch": "run watch"
   },
   "peerDependencies": {
-    "@babel/preset-react": "^7.0.0",
     "@testing-library/react": "^12.0.0",
     "@types/react": "^17.0.0",
     "eslint-plugin-react": "^7.0.0",
     "eslint-plugin-testing-library": "^5.0.0",
-    "presetter": "^3.1.0"
+    "presetter": "^3.3.0"
   },
   "devDependencies": {
     "presetter": "file:../presetter",

package/templates/eslintrc.yaml

@@ -11,3 +11,15 @@ rules:
     - warn
     - callbacksLast: true
       shorthandFirst: true
+overrides:
+  - files:
+      - '**/__tests__/**/*.[jt]sx'
+      - '**/?(*.)+(spec|test).[jt]sx'
+    extends:
+      - plugin:testing-library/react
+  - files:
+      - src/**/*.tsx
+    rules:
+      max-lines-per-function:
+        - warn
+        - max: 120

package/templates/tsconfig.yaml

@@ -4,7 +4,7 @@ compilerOptions:
   module: commonjs # node doesn't support anything non commonjs code yet
   target: ES2017 # use ES2017 as it's the latest standard node 10 can be fully compatible with
   declaration: true
-  sourceMap: true
+  inlineSourceMap: true
 
   # compatibility
   allowSyntheticDefaultImports: true

package/lib/index.js.map

@@ -1 +0,0 @@
-{"version":3,"sources":["../source/index.ts"],"names":["TEMPLATES","__dirname","CONFIGS","DEFAULT_VARIABLE","source","types","output","IMAGE_TYPE","STYLE_TYPE","template","custom","variable","noSymlinks","supplementaryConfig","eslint","gitignore","jest","lintstaged","rollup"],"mappings":";;;;;;;;AAeA;;AAfA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAMA;AACA,MAAMA,SAAS,GAAG,mBAAQC,SAAR,EAAmB,IAAnB,EAAyB,WAAzB,CAAlB;AACA,MAAMC,OAAO,GAAG,mBAAQD,SAAR,EAAmB,IAAnB,EAAyB,SAAzB,CAAhB;AAEA;;AAkBO,MAAME,gBAA0B,GAAG;AACxCC,EAAAA,MAAM,EAAE,QADgC;AAExCC,EAAAA,KAAK,EAAE,OAFiC;AAGxCC,EAAAA,MAAM,EAAE;AAHgC,CAAnC;;AAMP,MAAMC,UAAU,GAAG,YAAnB;AACA,MAAMC,UAAU,GAAG,YAAnB;;AAEA,MAAMC,QAAiC,GAAG,CAAC;AACzCC,EAAAA,MAAM,EAAE;AACNC,IAAAA,QAAQ,EAAE;AAAEN,MAAAA;AAAF;AADJ;AADiC,CAAD,MAInC;AACL,oBAAkB,mBAAQL,SAAR,EAAmB,eAAnB,CADb;AAEL,mBAAiB,mBAAQA,SAAR,EAAmB,eAAnB,CAFZ;AAGL,GAAC,gBAAKK,KAAL,EAAYE,UAAZ,CAAD,GAA2B,mBAAQP,SAAR,EAAmBO,UAAnB,CAHtB;AAIL,GAAC,gBAAKF,KAAL,EAAYG,UAAZ,CAAD,GAA2B,mBAAQR,SAAR,EAAmBQ,UAAnB;AAJtB,CAJmC,CAA1C;;AAWA,MAAMI,UAAqC,GAAG,CAAC;AAC7CF,EAAAA,MAAM,EAAE;AACNC,IAAAA,QAAQ,EAAE;AAAEN,MAAAA;AAAF;AADJ;AADqC,CAAD,KAIxC,CAAC,gBAAKA,KAAL,EAAYE,UAAZ,CAAD,EAA0B,gBAAKF,KAAL,EAAYG,UAAZ,CAA1B,CAJN;;AAMA,MAAMK,mBAAuD,GAAG;AAC9DC,EAAAA,MAAM,EAAE,mBAAQZ,OAAR,EAAiB,aAAjB,CADsD;AAE9Da,EAAAA,SAAS,EAAE,CAAC;AACVL,IAAAA,MAAM,EAAE;AACNC,MAAAA,QAAQ,EAAE;AAAEN,QAAAA;AAAF;AADJ;AADE,GAAD,KAIL,CAAC,gBAAK,GAAL,EAAUA,KAAV,EAAiBE,UAAjB,CAAD,EAA+B,gBAAK,GAAL,EAAUF,KAAV,EAAiBG,UAAjB,CAA/B,CANwD;AAO9DQ,EAAAA,IAAI,EAAE,mBAAQd,OAAR,EAAiB,WAAjB,CAPwD;AAQ9De,EAAAA,UAAU,EAAE,mBAAQf,OAAR,EAAiB,iBAAjB,CARkD;AAS9DgB,EAAAA,MAAM,EAAE,mBAAQhB,OAAR,EAAiB,aAAjB;AATsD,CAAhE;AAYA;AACA;AACA;AACA;;AACe,0BAAwC;AACrD,SAAO;AACLO,IAAAA,QADK;AAELG,IAAAA,UAFK;AAGLC,IAAAA,mBAHK;AAILF,IAAAA,QAAQ,EAAER;AAJL,GAAP;AAMD","sourcesContent":["/*\n *                            *** MIT LICENSE ***\n * -------------------------------------------------------------------------\n * This code may be modified and distributed under the MIT license.\n * See the LICENSE file for details.\n * -------------------------------------------------------------------------\n *\n * @summary   Preset for a React project\n *\n * @author    Alvis HT Tang <alvis@hilbert.space>\n * @license   MIT\n * @copyright Copyright (c) 2021 - All Rights Reserved.\n * -------------------------------------------------------------------------\n */\n\nimport { join, resolve } from 'path';\n\nimport type { PresetAsset } from 'presetter';\n\n// paths to the template directory\nconst TEMPLATES = resolve(__dirname, '..', 'templates');\nconst CONFIGS = resolve(__dirname, '..', 'configs');\n\n/** config for this preset */\nexport type PresetConfig = {\n  /** configuration to be merged with .eslintrc */\n  eslint?: Record<string, unknown>;\n  /** configuration to be merged with tsconfig.json */\n  tsconfig?: Record<string, unknown>;\n};\n\n/** list of configurable variables */\nexport type Variable = {\n  /** the directory containing all source code (default: source) */\n  source?: string;\n  /** the directory containing all extra typing files (default: types) */\n  types?: string;\n  /** the directory containing all the compiled files (default: lib) */\n  output?: string;\n};\n\nexport const DEFAULT_VARIABLE: Variable = {\n  source: 'source',\n  types: 'types',\n  output: 'lib',\n};\n\nconst IMAGE_TYPE = 'image.d.ts';\nconst STYLE_TYPE = 'style.d.ts';\n\nconst template: PresetAsset['template'] = ({\n  custom: {\n    variable: { types },\n  },\n}) => ({\n  '.eslintrc.json': resolve(TEMPLATES, 'eslintrc.yaml'),\n  'tsconfig.json': resolve(TEMPLATES, 'tsconfig.yaml'),\n  [join(types, IMAGE_TYPE)]: resolve(TEMPLATES, IMAGE_TYPE),\n  [join(types, STYLE_TYPE)]: resolve(TEMPLATES, STYLE_TYPE),\n});\n\nconst noSymlinks: PresetAsset['noSymlinks'] = ({\n  custom: {\n    variable: { types },\n  },\n}) => [join(types, IMAGE_TYPE), join(types, STYLE_TYPE)];\n\nconst supplementaryConfig: PresetAsset['supplementaryConfig'] = {\n  eslint: resolve(CONFIGS, 'eslint.yaml'),\n  gitignore: ({\n    custom: {\n      variable: { types },\n    },\n  }) => [join('/', types, IMAGE_TYPE), join('/', types, STYLE_TYPE)],\n  jest: resolve(CONFIGS, 'jest.yaml'),\n  lintstaged: resolve(CONFIGS, 'lintstaged.yaml'),\n  rollup: resolve(CONFIGS, 'rollup.yaml'),\n};\n\n/**\n * get the list of templates provided by this preset\n * @returns list of preset templates\n */\nexport default async function (): Promise<PresetAsset> {\n  return {\n    template,\n    noSymlinks,\n    supplementaryConfig,\n    variable: DEFAULT_VARIABLE,\n  };\n}\n"],"file":"index.js"}