juisy 2.0.0-beta.0 → 2.0.0-beta.10

package/dist/templater/markdown-templater/ReadmeTemplater.d.ts

@@ -1,5 +1,10 @@
 import { default as ejs } from 'ejs';
-type Configuration = {
+import { markdownTable } from 'markdown-table';
+import { default as asciitree } from 'ascii-tree';
+/**
+ * @group Types
+ */
+export type Configuration = {
     /**
      * Output file name: `README.md` by default. Only for **generate** method
      */
@@ -40,6 +45,9 @@ type Configuration = {
      */
     slugify: Function;
 };
+/**
+ * @group Types
+ */
 export type UserConfiguration = {
     fileName?: Configuration['fileName'];
     destFolder?: Configuration['destFolder'];
@@ -51,25 +59,25 @@ export type UserConfiguration = {
     slugify?: Configuration['slugify'];
 };
 export declare class ReadmeTemplater {
+    /**
+     * @param config - The user configuration file path (as string) or object
+     * @example
+     * // Path as string
+     * const templater = new ReadmeTemplater('./.docs/readme/config.js')
+     * // Pass object. See configuration below
+     * const templater = new ReadmeTemplater({ /* ... *\/ })
+     */
     constructor(config: Parameters<typeof ReadmeTemplater.processConfig>[0]);
     private config;
     private templater;
     /**
-     * @param {Configuration|string} config - The config object to process. Can be path to config file as string.
-     * @param {object} [options] - Same as render
-     * @returns {void|Promise<void>} Promise is immediately resolved except if a module is async.
-     * @throws Throws error if render or file writing fails
-     * @description
      * Writes rendered README markdown to file
+     * @param config - The config object to process. Can be path to config file as string.
+     * @param options - Same as render
+     * @throws Throws error if render or file writing fails
      * @example
-     * readmeGenerator.generate(config) // => output to README.md file
-     * readmeGenerator.generate('./.docs/readme/config.js') // pass config path
-     * readmeGenerator.generate(config, { data: { foo: 'bar' } }) // pass options
-     * // Async
-     * await readmeGenerator.generate('./.docs/readme/config.js') // async module
-     * await readmeGenerator.generate({
-     *   ejsDataPath: '/path/to/ejs/data.js' // async module
-     * })
+     * await templater.generate() // => output to README.md file
+     * await templater.generate({ data: { foo: 'bar' } }) // pass options
      */
     generate(options?: {}): Promise<void>;
     /**
@@ -78,14 +86,8 @@ export declare class ReadmeTemplater {
      * @param options.data - Additionnal data object to merge with default EJS data
      * @returns Returns the rendered markdown as string. Promise is immediately resolved except if a module is async.
      * @example
-     * const result = readmeGenerator.render(config)
-     * const result = readmeGenerator.render('./.docs/readme/config.js')
-     * const result = readmeGenerator.render(config, { data: { foo: 'bar' } })
-     * // Async
-     * const result = await readmeGenerator.render('./.docs/readme/config.js') // async module
-     * const result = await readmeGenerator.render({
-     *   ejsDataPath: '/path/to/ejs/data.js' // async module
-     * })
+     * await templater.render()
+     * await templater.render({ data: { foo: 'bar' } })
      */
     render(options?: {
         data?: Record<any, any>;
@@ -105,12 +107,8 @@ export declare class ReadmeTemplater {
      */
     static processConfig(config: UserConfiguration | string): Promise<Configuration>;
     /**
-     * @alias module:readme-generator.defaultConfig
-     * @type {Configuration}
-     * @description
      * Returns the default configuration object.
      * This base configuration is used by `processConfig` method and so `generate` and `render` methods.
-     * See also {@link module:readme-generator~Configuration Configuration} defaults.
      */
     static defaultConfig: Configuration;
     /**
@@ -148,7 +146,9 @@ export declare class ReadmeTemplater {
          * // Generates an ascii tree
          * $utils.asciiTree('*.\n**a\n**b\n*...')
          */
-        $utils: any;
+        $utils: {
+            table: typeof markdownTable;
+            asciiTree: typeof asciitree.generate;
+        };
     };
 }
-export {};

package/dist/templater/markdown-templater/index.d.ts

@@ -1,6 +1,9 @@
 import { remark } from 'remark';
 import { Templater } from '../Templater';
 import { TemplaterOptions } from '../types';
+/**
+ * @group Types
+ */
 export type MarkdownTemplaterOptions = TemplaterOptions<any> & {
     processor?: 'remark' | typeof remark;
     /**

package/dist/templater/types.d.ts

@@ -1,6 +1,12 @@
 import { Options as EJSOptions } from 'ejs';
 import { compile as HandlebarsCompiler } from 'handlebars';
+/**
+ * @group Types
+ */
 export type SupportedEngines = ['handlebars', 'ejs', 'pug'];
+/**
+ * @group Types
+ */
 export type TemplaterOptions<E extends SupportedEngines[number]> = {
     engineOptions?: E extends 'handlebars' ? Parameters<typeof HandlebarsCompiler>[1] : E extends 'ejs' ? EJSOptions : unknown;
     /**

package/dist/utils/misc.d.ts

@@ -8,7 +8,7 @@ import { GlobOptions } from 'glob';
  * @example
  * utils.getFileUrls('path/to/*.js') // => [ 'path/to/file1.js', 'path/to/file2.js', ... ]
  */
-export declare function getFileUrls(pattern: string, options?: GlobOptions): string[] | import('path-scurry').Path[];
+export declare function getFileUrls(pattern: string, options?: GlobOptions): string[] | import('glob').Path[];
 /**
  * @param dir - The directory path
  * @returns Returns an array of file path

package/package.json

@@ -1,179 +1,201 @@
-{
-    "name": "juisy",
-    "version": "2.0.0-beta.0",
-    "description": "Make your JavaScript (and/or TypeScript) project juicy!",
-    "main": "src/index.js",
-    "type": "module",
-    "files": [
-        "bin",
-        "dist",
-        "template"
-    ],
-    "exports": {
-        ".": {
-            "types": "./dist/index.d.ts",
-            "import": "./dist/index.js"
-        },
-        "./cli": {
-            "types": "./dist/cli/index.d.ts",
-            "import": "./dist/cli/index.js"
-        },
-        "./templater": {
-            "types": "./dist/templater/index.d.ts",
-            "import": "./dist/templater/index.js"
-        }
-    },
-    "imports": {
-        "#juisy": {
-            "types": "./dist/index.d.ts",
-            "import": "./dist/index.js"
-        },
-        "#juisy/cli": {
-            "types": "./dist/cli/index.d.ts",
-            "import": "./dist/cli/index.js"
-        },
-        "#juisy/templater": {
-            "types": "./dist/templater/index.d.ts",
-            "import": "./dist/templater/index.js"
-        }
-    },
-    "publishConfig": {
-        "access": "public"
-    },
-    "scripts": {
-        "build": "vite build",
-        "audit": "ncu && npm audit",
-        "audit:fix": "ncu --interactive",
-        "docs:api": "npx cross-env CLI_ENV=private node ./bin/cli docs generate:api",
-        "docs:readme": "npx cross-env CLI_ENV=private node ./bin/cli docs generate:readme",
-        "docs:cli": "npx cross-env CLI_ENV=private node ./bin/cli docs generate:cli",
-        "docs:lint": "npx cross-env CLI_ENV=private node ./bin/cli docs lint -c ./docs/.markdownlint-cli2.cjs",
-        "docs:lint:fix": "npm run docs:lint -- --fix",
-        "docs": "npm run docs:readme && npm run docs:cli && npm run docs:api && npm run docs:lint",
-        "lint": "eslint .",
-        "lint:fix": "npm run lint -- --fix",
-        "lint:markdown": "npm run docs:lint",
-        "lint:markdown:fix": "npm run docs:lint:fix",
-        "release": "npx cross-env CLI_ENV=private NODE_ENV=development node ./bin/cli release",
-        "changelog": "npx cross-env CLI_ENV=private NODE_ENV=development node ./bin/cli changelog",
-        "example:reset": "git checkout --no-overlay -- example && cd example && git clean -fdX",
-        "example:test": "npm run example:reset && cd example && npm install -D @hperchec/juisy@file:../ && npx juisy squeeze && npm run docs:readme",
-        "git-hooks:reset": "npx cross-env CLI_ENV=private NODE_ENV=development node ./bin/cli git-hooks reset",
-        "git-hooks:sync": "npx cross-env CLI_ENV=private NODE_ENV=development node ./bin/cli git-hooks sync",
-        "print:globals": "node --no-warnings ./bin/cli print:globals",
-        "test": "npx cross-env CLI_ENV=private node ./bin/cli test",
-        "test:dev": "npm test -- --watch",
-        "test:ui": "npm test -- --ui",
-        "__prepare": "npm run git-hooks:sync"
-    },
-    "repository": {
-        "type": "git",
-        "url": "git+https://gitlab.com/hperchec/juisy.git"
-    },
-    "keywords": [
-        "js",
-        "build",
-        "release",
-        "changelog",
-        "bin",
-        "cmd",
-        "easy"
-    ],
-    "author": {
-        "name": "Hervé Perchec",
-        "email": "contact@herve-perchec.com",
-        "url": "https://gitlab.com/herveperchec"
-    },
-    "license": "ISC",
-    "bugs": {
-        "url": "https://gitlab.com/hperchec/juisy/issues"
-    },
-    "homepage": "https://gitlab.com/hperchec/juisy#readme",
-    "bin": {
-        "juisy": "./bin/cli/index.js"
-    },
-    "simple-git-hooks": {
-        "pre-commit": "node ./bin/scripts/pre-commit.js",
-        "commit-msg": "node ./bin/scripts/commit-msg.js ${1}"
-    },
-    "lint-staged": {
-        "*.{js,cjs,ts}": [
-            "eslint --fix",
-            "git add"
-        ]
-    },
-    "peerDependencies": {
-        "@commitlint/cli": "^17.7.2",
-        "@commitlint/config-conventional": "^17.7.0",
-        "@github/markdownlint-github": "^0.6.0",
-        "@hperchec/readme-generator": "^3.0.0",
-        "@stylistic/eslint-plugin": "^2",
-        "@typescript-eslint/eslint-plugin": "^8",
-        "chalk": "^4.1.2",
-        "conventional-changelog-cli": "^4.1.0",
-        "eslint": "^9",
-        "execa": "^5.1.1",
-        "lint-staged": "^14.0.1",
-        "markdownlint-cli2": "^0.12.1",
-        "markdownlint-cli2-formatter-pretty": "^0.0.6",
-        "prompts": "^2.4.2",
-        "simple-git-hooks": "^2.9.0",
-        "yargs": "^17.7.2"
-    },
-    "devDependencies": {
-        "@commitlint/cli": "^19.6.1",
-        "@commitlint/config-conventional": "^19.6.0",
-        "@github/markdownlint-github": "^0.6.3",
-        "@rollup/plugin-typescript": "^12.1.2",
-        "@stylistic/eslint-plugin": "^2.12.1",
-        "@types/ejs": "^3.1.5",
-        "@types/fs-extra": "^11.0.4",
-        "@types/lodash.merge": "^4.6.9",
-        "@types/prompts": "^2.4.9",
-        "@types/yargs": "^17.0.33",
-        "@typescript-eslint/eslint-plugin": "^8.18.1",
-        "@vitest/coverage-v8": "^2.1.8",
-        "@vitest/ui": "^2.1.8",
-        "conventional-changelog-cli": "^5.0.0",
-        "eslint": "^9.17.0",
-        "happy-dom": "^15.11.7",
-        "lint-staged": "^14.0.1",
-        "markdown-table": "^3.0.4",
-        "markdownlint-cli2": "^0.16.0",
-        "markdownlint-cli2-formatter-pretty": "^0.0.7",
-        "npm-check-updates": "^17.1.12",
-        "typescript": "^5.7.2",
-        "vite": "^5.4.11",
-        "vite-plugin-dts": "^4.3.0",
-        "vitest": "^2.1.8"
-    },
-    "dependencies": {
-        "@dotenvx/dotenvx": "^1.31.0",
-        "ascii-tree": "^0.3.0",
-        "chalk": "^4.1.2",
-        "deepmerge": "^4.3.1",
-        "ejs": "^3.1.10",
-        "execa": "^5.1.1",
-        "find-up": "^7.0.0",
-        "fs-extra": "^11.2.0",
-        "github-slugger": "^2.0.0",
-        "glob": "^11.0.0",
-        "indent-string": "^5.0.0",
-        "json-2-csv": "^5.5.7",
-        "jstoxml": "^5.0.2",
-        "lodash.merge": "^4.6.2",
-        "loglevel": "^1.9.2",
-        "markdown-toc": "^1.2.0",
-        "markdown-utils": "^1.0.0",
-        "package-json-type": "^1.0.3",
-        "pkg-dir": "^8.0.0",
-        "prompts": "^2.4.2",
-        "remark": "^15.0.1",
-        "remark-frontmatter": "^5.0.0",
-        "remark-toc": "^9.0.0",
-        "simple-git-hooks": "^2.9.0",
-        "strip-ansi": "^7.1.0",
-        "yaml": "^2.6.1",
-        "yargs": "^17.7.2"
-    }
-}
+{
+    "name": "juisy",
+    "version": "2.0.0-beta.10",
+    "description": "Make your JavaScript (and/or TypeScript) project juicy!",
+    "type": "module",
+    "files": [
+        "bin",
+        "dist"
+    ],
+    "engines": {
+        "node": "^18.0.0 || ^20.0.0 || >=22.0.0"
+    },
+    "imports": {
+        "#juisy": {
+            "types": "./dist/index.d.ts",
+            "import": "./dist/index.js"
+        },
+        "#juisy/cli": {
+            "types": "./dist/cli/index.d.ts",
+            "import": "./dist/cli/index.js"
+        },
+        "#juisy/templater": {
+            "types": "./dist/templater/index.d.ts",
+            "import": "./dist/templater/index.js"
+        }
+    },
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "import": "./dist/index.js"
+        },
+        "./cli": {
+            "types": "./dist/cli/index.d.ts",
+            "import": "./dist/cli/index.js"
+        },
+        "./templater": {
+            "types": "./dist/templater/index.d.ts",
+            "import": "./dist/templater/index.js"
+        }
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "scripts": {
+        "build": "vite build",
+        "audit": "ncu && npm audit",
+        "audit:fix": "ncu --interactive",
+        "docs": "npm run docs:cli && npm run docs:api",
+        "docs:api": "node ./bin/cli docs generate:api",
+        "docs:cli": "npm run docs:cli:private && npm run docs:cli:public",
+        "docs:cli:private": "node ./bin/cli docs generate:cli -c ./docs/cli/private/config.js",
+        "docs:cli:public": "node ./bin/cli docs generate:cli -c ./docs/cli/public/config.js",
+        "example:reset": "git checkout --no-overlay -- example && cd example && git clean -fdX",
+        "example:test": "npm run example:reset && cd example && npm install -D juisy@file:../ && npx juisy squeeze && npm run docs:readme",
+        "print:globals": "node --no-warnings ./bin/cli print:globals",
+        "release": "release-it",
+        "test": "node ./bin/cli test",
+        "test:dev": "npm test -- --watch",
+        "test:ui": "npm test -- --ui"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://gitlab.com/hperchec/juisy.git"
+    },
+    "keywords": [
+        "js",
+        "build",
+        "release",
+        "changelog",
+        "bin",
+        "cmd",
+        "easy"
+    ],
+    "author": {
+        "name": "Hervé Perchec",
+        "email": "contact@herve-perchec.com",
+        "url": "https://gitlab.com/herveperchec"
+    },
+    "license": "GPL-3.0-only",
+    "bugs": {
+        "url": "https://gitlab.com/hperchec/juisy/issues"
+    },
+    "homepage": "https://hperchec.gitlab.io/juisy",
+    "bin": {
+        "juisy": "./bin/cli/index.js"
+    },
+    "peerDependencies": {
+        "@commitlint/cli": "^19.6.1",
+        "@commitlint/config-conventional": "^19.6.0",
+        "@github/markdownlint-github": "^0.7.0",
+        "@release-it/bumper": "6.0.1",
+        "@release-it/conventional-changelog": "^9.0.4",
+        "@stylistic/eslint-plugin": "^2",
+        "@typescript-eslint/eslint-plugin": "^8",
+        "chalk": "^4.1.2",
+        "conventional-changelog-cli": "^5.0.0",
+        "eslint": "^9",
+        "lint-staged": "^14.0.1",
+        "markdownlint-cli2": "^0.12.0",
+        "markdownlint-cli2-formatter-pretty": "^0.0.7",
+        "prompts": "^2.4.2",
+        "release-it": "^17.11.0",
+        "simple-git-hooks": "^2.9.0",
+        "yargs": "^17.7.2"
+    },
+    "peerDependenciesMeta": {
+        "@github/markdownlint-github": {
+            "optional": true
+        },
+        "@release-it/bumper": {
+            "optional": true
+        },
+        "@release-it/conventional-changelog": {
+            "optional": true
+        },
+        "markdownlint-cli2-formatter-pretty": {
+            "optional": true
+        }
+    },
+    "devDependencies": {
+        "@babel/eslint-parser": "^7.25.9",
+        "@conventional-changelog/git-client": "^1.0.1",
+        "@rollup/plugin-typescript": "^12.1.2",
+        "@stylistic/eslint-plugin": "^2.12.1",
+        "@types/conventional-changelog": "^3.1.5",
+        "@types/conventional-changelog-config-spec": "^2.1.5",
+        "@types/ejs": "^3.1.5",
+        "@types/fs-extra": "^11.0.4",
+        "@types/lint-staged": "^13.3.0",
+        "@types/lodash.get": "^4.4.9",
+        "@types/lodash.kebabcase": "^4.1.9",
+        "@types/lodash.merge": "^4.6.9",
+        "@types/lodash.set": "^4.3.9",
+        "@types/node": "^22.10.2",
+        "@types/prompts": "^2.4.9",
+        "@types/semver": "^7.5.8",
+        "@types/yargs": "^17.0.33",
+        "@types/yargs-parser": "^21.0.3",
+        "@typescript-eslint/eslint-plugin": "^8.18.1",
+        "@vitest/coverage-v8": "^2.1.8",
+        "@vitest/ui": "^2.1.8",
+        "cpy-cli": "^5.0.0",
+        "eslint": "^9.17.0",
+        "happy-dom": "^15.11.7",
+        "json-schema-to-ts": "^3.1.1",
+        "lint-staged": "^14.0.1",
+        "markdown-table": "^3.0.4",
+        "npm-check-updates": "^17.1.12",
+        "quicktype": "^23.0.170",
+        "typescript": "^5.7.2",
+        "vite": "^5.4.11",
+        "vite-plugin-dts": "^4.3.0",
+        "vite-plugin-generate-file": "^0.2.0",
+        "vitest": "^2.1.8"
+    },
+    "dependencies": {
+        "@dotenvx/dotenvx": "^1.31.0",
+        "ascii-tree": "^0.3.0",
+        "chalk": "^4.1.2",
+        "conventional-recommended-bump": "^10.0.0",
+        "deepmerge": "^4.3.1",
+        "ejs": "^3.1.10",
+        "execa": "^8",
+        "find-up": "^7.0.0",
+        "fs-extra": "^11.2.0",
+        "github-slugger": "^2.0.0",
+        "glob": "^11.0.0",
+        "handlebars": "^4.7.8",
+        "import-single-ts": "^1.2.0",
+        "indent-string": "^5.0.0",
+        "json-2-csv": "^5.5.7",
+        "jstoxml": "^5.0.2",
+        "lodash.get": "^4.4.2",
+        "lodash.kebabcase": "^4.1.1",
+        "lodash.merge": "^4.6.2",
+        "lodash.set": "^4.3.2",
+        "loglevel": "^1.9.2",
+        "markdown-toc": "^1.2.0",
+        "markdown-utils": "^1.0.0",
+        "package-json-type": "^1.0.3",
+        "pkg-dir": "^8.0.0",
+        "prompts": "^2.4.2",
+        "remark": "^15.0.1",
+        "remark-frontmatter": "^5.0.0",
+        "remark-toc": "^9.0.0",
+        "semver": "^7.7.1",
+        "simple-git-hooks": "^2.9.0",
+        "strip-ansi": "^7.1.0",
+        "ts-json-schema-generator": "^2.3.0",
+        "typedoc": "^0.27.5",
+        "typedoc-plugin-frontmatter": "^1.1.2",
+        "typedoc-plugin-markdown": "^4.3.3",
+        "typedoc-vitepress-theme": "^1.1.1",
+        "yaml": "^2.6.1",
+        "yargs": "^17.7.2",
+        "yargs-parser": "^21.1.1"
+    },
+    "release-it": {
+        "git": false
+    }
+}