presetter-preset-react 4.5.0 → 4.7.0

package/lib/index.d.ts

@@ -1,13 +1,24 @@
 import type { PresetAsset } from 'presetter-types';
+/** config for this preset */
 export type PresetConfig = {
+    /** configuration to be merged with .eslintrc */
     eslint?: Record<string, unknown>;
+    /** configuration to be merged with tsconfig.json */
     tsconfig?: Record<string, unknown>;
 };
+/** list of configurable variables */
 export type Variable = {
+    /** the directory containing all source code (default: source) */
     source?: string;
+    /** the directory containing all extra typing files (default: types) */
     types?: string;
+    /** the directory containing all the compiled files (default: lib) */
     output?: string;
 };
 export declare const DEFAULT_VARIABLE: Variable;
+/**
+ * get the list of templates provided by this preset
+ * @returns list of preset templates
+ */
 export default function (): Promise<PresetAsset>;
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../source/index.ts"],"names":[],"mappings":"AAkBA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AASnD,MAAM,MAAM,YAAY,GAAG;IAEzB,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEjC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC,CAAC;AAGF,MAAM,MAAM,QAAQ,GAAG;IAErB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,eAAO,MAAM,gBAAgB,EAAE,QAI9B,CAAC;AAuCF,4BAAkC,OAAO,CAAC,WAAW,CAAC,CAQrD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../source/index.ts"],"names":[],"mappings":"AAkBA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAQnD,6BAA6B;AAC7B,MAAM,MAAM,YAAY,GAAG;IACzB,gDAAgD;IAChD,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,oDAAoD;IACpD,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC,CAAC;AAEF,qCAAqC;AACrC,MAAM,MAAM,QAAQ,GAAG;IACrB,iEAAiE;IACjE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,uEAAuE;IACvE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,qEAAqE;IACrE,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,eAAO,MAAM,gBAAgB,EAAE,QAI9B,CAAC;AAmCF;;;GAGG;AACH,4BAAkC,OAAO,CAAC,WAAW,CAAC,CAQrD"}

package/lib/index.js

@@ -1,6 +1,21 @@
+/*
+ *                            *** 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.
+ * -------------------------------------------------------------------------
+ */
 import { dirname, join, resolve } from 'node:path';
 import { fileURLToPath } from 'node:url';
 const DIR = fileURLToPath(dirname(import.meta.url));
+// paths to the template directory
 const TEMPLATES = resolve(DIR, '..', 'templates');
 const CONFIGS = resolve(DIR, '..', 'configs');
 export const DEFAULT_VARIABLE = {
@@ -11,10 +26,12 @@ export const DEFAULT_VARIABLE = {
 const IMAGE_TYPE = 'image.d.ts';
 const STYLE_TYPE = 'style.d.ts';
 const template = ({ custom: { variable: { types }, }, }) => ({
+    /* eslint-disable @typescript-eslint/naming-convention */
     '.eslintrc.json': resolve(TEMPLATES, 'eslintrc.yaml'),
     'tsconfig.json': resolve(TEMPLATES, 'tsconfig.yaml'),
     [join(types, IMAGE_TYPE)]: resolve(TEMPLATES, IMAGE_TYPE),
     [join(types, STYLE_TYPE)]: resolve(TEMPLATES, STYLE_TYPE),
+    /* eslint-enable @typescript-eslint/naming-convention */
 });
 const noSymlinks = ({ custom: { variable: { types }, }, }) => [join(types, IMAGE_TYPE), join(types, STYLE_TYPE)];
 const supplementaryConfig = {
@@ -23,6 +40,10 @@ const supplementaryConfig = {
     jest: resolve(CONFIGS, 'jest.yaml'),
     lintstaged: resolve(CONFIGS, 'lintstaged.yaml'),
 };
+/**
+ * get the list of templates provided by this preset
+ * @returns list of preset templates
+ */
 export default async function () {
     return {
         scripts: resolve(TEMPLATES, 'scripts.yaml'),
@@ -32,4 +53,4 @@ export default async function () {
         variable: DEFAULT_VARIABLE,
     };
 }
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zb3VyY2UvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBZUEsT0FBTyxFQUFFLE9BQU8sRUFBRSxJQUFJLEVBQUUsT0FBTyxFQUFFLE1BQU0sV0FBVyxDQUFDO0FBQ25ELE9BQU8sRUFBRSxhQUFhLEVBQUUsTUFBTSxVQUFVLENBQUM7QUFJekMsTUFBTSxHQUFHLEdBQUcsYUFBYSxDQUFDLE9BQU8sQ0FBQyxNQUFNLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUM7QUFHcEQsTUFBTSxTQUFTLEdBQUcsT0FBTyxDQUFDLEdBQUcsRUFBRSxJQUFJLEVBQUUsV0FBVyxDQUFDLENBQUM7QUFDbEQsTUFBTSxPQUFPLEdBQUcsT0FBTyxDQUFDLEdBQUcsRUFBRSxJQUFJLEVBQUUsU0FBUyxDQUFDLENBQUM7QUFvQjlDLE1BQU0sQ0FBQyxNQUFNLGdCQUFnQixHQUFhO0lBQ3hDLE1BQU0sRUFBRSxRQUFRO0lBQ2hCLEtBQUssRUFBRSxPQUFPO0lBQ2QsTUFBTSxFQUFFLEtBQUs7Q0FDZCxDQUFDO0FBRUYsTUFBTSxVQUFVLEdBQUcsWUFBWSxDQUFDO0FBQ2hDLE1BQU0sVUFBVSxHQUFHLFlBQVksQ0FBQztBQUVoQyxNQUFNLFFBQVEsR0FBNEIsQ0FBQyxFQUN6QyxNQUFNLEVBQUUsRUFDTixRQUFRLEVBQUUsRUFBRSxLQUFLLEVBQUUsR0FDcEIsR0FDRixFQUFFLEVBQUUsQ0FBQyxDQUFDO0lBRUwsZ0JBQWdCLEVBQUUsT0FBTyxDQUFDLFNBQVMsRUFBRSxlQUFlLENBQUM7SUFDckQsZUFBZSxFQUFFLE9BQU8sQ0FBQyxTQUFTLEVBQUUsZUFBZSxDQUFDO0lBQ3BELENBQUMsSUFBSSxDQUFDLEtBQUssRUFBRSxVQUFVLENBQUMsQ0FBQyxFQUFFLE9BQU8sQ0FBQyxTQUFTLEVBQUUsVUFBVSxDQUFDO0lBQ3pELENBQUMsSUFBSSxDQUFDLEtBQUssRUFBRSxVQUFVLENBQUMsQ0FBQyxFQUFFLE9BQU8sQ0FBQyxTQUFTLEVBQUUsVUFBVSxDQUFDO0NBRTFELENBQUMsQ0FBQztBQUVILE1BQU0sVUFBVSxHQUE4QixDQUFDLEVBQzdDLE1BQU0sRUFBRSxFQUNOLFFBQVEsRUFBRSxFQUFFLEtBQUssRUFBRSxHQUNwQixHQUNGLEVBQUUsRUFBRSxDQUFDLENBQUMsSUFBSSxDQUFDLEtBQUssRUFBRSxVQUFVLENBQUMsRUFBRSxJQUFJLENBQUMsS0FBSyxFQUFFLFVBQVUsQ0FBQyxDQUFDLENBQUM7QUFFekQsTUFBTSxtQkFBbUIsR0FBdUM7SUFDOUQsTUFBTSxFQUFFLE9BQU8sQ0FBQyxPQUFPLEVBQUUsYUFBYSxDQUFDO0lBQ3ZDLFNBQVMsRUFBRSxDQUFDLEVBQ1YsTUFBTSxFQUFFLEVBQ04sUUFBUSxFQUFFLEVBQUUsS0FBSyxFQUFFLEdBQ3BCLEdBQ0YsRUFBRSxFQUFFLENBQUMsQ0FBQyxJQUFJLENBQUMsR0FBRyxFQUFFLEtBQUssRUFBRSxVQUFVLENBQUMsRUFBRSxJQUFJLENBQUMsR0FBRyxFQUFFLEtBQUssRUFBRSxVQUFVLENBQUMsQ0FBQztJQUNsRSxJQUFJLEVBQUUsT0FBTyxDQUFDLE9BQU8sRUFBRSxXQUFXLENBQUM7SUFDbkMsVUFBVSxFQUFFLE9BQU8sQ0FBQyxPQUFPLEVBQUUsaUJBQWlCLENBQUM7Q0FDaEQsQ0FBQztBQU1GLE1BQU0sQ0FBQyxPQUFPLENBQUMsS0FBSztJQUNsQixPQUFPO1FBQ0wsT0FBTyxFQUFFLE9BQU8sQ0FBQyxTQUFTLEVBQUUsY0FBYyxDQUFDO1FBQzNDLFFBQVE7UUFDUixVQUFVO1FBQ1YsbUJBQW1CO1FBQ25CLFFBQVEsRUFBRSxnQkFBZ0I7S0FDM0IsQ0FBQztBQUNKLENBQUMifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zb3VyY2UvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUE7Ozs7Ozs7Ozs7Ozs7R0FhRztBQUVILE9BQU8sRUFBRSxPQUFPLEVBQUUsSUFBSSxFQUFFLE9BQU8sRUFBRSxNQUFNLFdBQVcsQ0FBQztBQUNuRCxPQUFPLEVBQUUsYUFBYSxFQUFFLE1BQU0sVUFBVSxDQUFDO0FBSXpDLE1BQU0sR0FBRyxHQUFHLGFBQWEsQ0FBQyxPQUFPLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDO0FBRXBELGtDQUFrQztBQUNsQyxNQUFNLFNBQVMsR0FBRyxPQUFPLENBQUMsR0FBRyxFQUFFLElBQUksRUFBRSxXQUFXLENBQUMsQ0FBQztBQUNsRCxNQUFNLE9BQU8sR0FBRyxPQUFPLENBQUMsR0FBRyxFQUFFLElBQUksRUFBRSxTQUFTLENBQUMsQ0FBQztBQW9COUMsTUFBTSxDQUFDLE1BQU0sZ0JBQWdCLEdBQWE7SUFDeEMsTUFBTSxFQUFFLFFBQVE7SUFDaEIsS0FBSyxFQUFFLE9BQU87SUFDZCxNQUFNLEVBQUUsS0FBSztDQUNkLENBQUM7QUFFRixNQUFNLFVBQVUsR0FBRyxZQUFZLENBQUM7QUFDaEMsTUFBTSxVQUFVLEdBQUcsWUFBWSxDQUFDO0FBRWhDLE1BQU0sUUFBUSxHQUE0QixDQUFDLEVBQ3pDLE1BQU0sRUFBRSxFQUNOLFFBQVEsRUFBRSxFQUFFLEtBQUssRUFBRSxHQUNwQixHQUNGLEVBQUUsRUFBRSxDQUFDLENBQUM7SUFDTCx5REFBeUQ7SUFDekQsZ0JBQWdCLEVBQUUsT0FBTyxDQUFDLFNBQVMsRUFBRSxlQUFlLENBQUM7SUFDckQsZUFBZSxFQUFFLE9BQU8sQ0FBQyxTQUFTLEVBQUUsZUFBZSxDQUFDO0lBQ3BELENBQUMsSUFBSSxDQUFDLEtBQUssRUFBRSxVQUFVLENBQUMsQ0FBQyxFQUFFLE9BQU8sQ0FBQyxTQUFTLEVBQUUsVUFBVSxDQUFDO0lBQ3pELENBQUMsSUFBSSxDQUFDLEtBQUssRUFBRSxVQUFVLENBQUMsQ0FBQyxFQUFFLE9BQU8sQ0FBQyxTQUFTLEVBQUUsVUFBVSxDQUFDO0lBQ3pELHdEQUF3RDtDQUN6RCxDQUFDLENBQUM7QUFFSCxNQUFNLFVBQVUsR0FBOEIsQ0FBQyxFQUM3QyxNQUFNLEVBQUUsRUFDTixRQUFRLEVBQUUsRUFBRSxLQUFLLEVBQUUsR0FDcEIsR0FDRixFQUFFLEVBQUUsQ0FBQyxDQUFDLElBQUksQ0FBQyxLQUFLLEVBQUUsVUFBVSxDQUFDLEVBQUUsSUFBSSxDQUFDLEtBQUssRUFBRSxVQUFVLENBQUMsQ0FBQyxDQUFDO0FBRXpELE1BQU0sbUJBQW1CLEdBQXVDO0lBQzlELE1BQU0sRUFBRSxPQUFPLENBQUMsT0FBTyxFQUFFLGFBQWEsQ0FBQztJQUN2QyxTQUFTLEVBQUUsQ0FBQyxFQUNWLE1BQU0sRUFBRSxFQUNOLFFBQVEsRUFBRSxFQUFFLEtBQUssRUFBRSxHQUNwQixHQUNGLEVBQUUsRUFBRSxDQUFDLENBQUMsSUFBSSxDQUFDLEdBQUcsRUFBRSxLQUFLLEVBQUUsVUFBVSxDQUFDLEVBQUUsSUFBSSxDQUFDLEdBQUcsRUFBRSxLQUFLLEVBQUUsVUFBVSxDQUFDLENBQUM7SUFDbEUsSUFBSSxFQUFFLE9BQU8sQ0FBQyxPQUFPLEVBQUUsV0FBVyxDQUFDO0lBQ25DLFVBQVUsRUFBRSxPQUFPLENBQUMsT0FBTyxFQUFFLGlCQUFpQixDQUFDO0NBQ2hELENBQUM7QUFFRjs7O0dBR0c7QUFDSCxNQUFNLENBQUMsT0FBTyxDQUFDLEtBQUs7SUFDbEIsT0FBTztRQUNMLE9BQU8sRUFBRSxPQUFPLENBQUMsU0FBUyxFQUFFLGNBQWMsQ0FBQztRQUMzQyxRQUFRO1FBQ1IsVUFBVTtRQUNWLG1CQUFtQjtRQUNuQixRQUFRLEVBQUUsZ0JBQWdCO0tBQzNCLENBQUM7QUFDSixDQUFDIn0=

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "presetter-preset-react",
-  "version": "4.5.0",
+  "version": "4.7.0",
   "description": "An opinionated presetter preset for a React project",
   "keywords": [
     "presetter",
@@ -24,13 +24,13 @@
     "@types/react": "^18.0.0",
     "eslint-plugin-react": "^7.0.0",
     "eslint-plugin-testing-library": "^5.0.0",
-    "presetter": "4.5.0"
+    "presetter": "4.7.0"
   },
   "devDependencies": {
-    "presetter": "4.5.0"
+    "presetter": "4.7.0"
   },
   "dependencies": {
-    "presetter-types": "4.5.0"
+    "presetter-types": "4.7.0"
   },
   "scripts": {
     "bootstrap": "run prepare",