@dword-design/base 16.2.7 → 17.0.0

package/dist/get-generated-files/get-vscode/index.d.ts

@@ -1,4 +1,5 @@
-export default function (): {
+import type { Base } from '@/src';
+declare const _default: (base: Base) => {
     'editor.tabSize': number;
     'files.autoSave': string;
     'files.exclude': {
@@ -6,3 +7,4 @@ export default function (): {
     };
     'workbench.editor.enablePreview': boolean;
 };
+export default _default;

package/dist/get-generated-files/get-vscode/index.js

@@ -1,8 +1,6 @@
-export default function () {
-  return {
-    "editor.tabSize": 2,
-    "files.autoSave": "off",
-    "files.exclude": Object.fromEntries(this.getEditorIgnoreConfig().map(entry => [entry, true])),
-    "workbench.editor.enablePreview": false
-  };
-}
+export default base => ({
+  "editor.tabSize": 2,
+  "files.autoSave": "off",
+  "files.exclude": Object.fromEntries(base.getEditorIgnoreConfig().map(entry => [entry, true])),
+  "workbench.editor.enablePreview": false
+});

package/dist/get-generated-files/index.d.ts

@@ -1,4 +1,5 @@
-export default function (): {
+import type { Base } from '@/src';
+declare const _default: (base: Base) => {
     '.commitlintrc.json': string;
     '.cz.json': string;
     '.devcontainer/devcontainer.json': string;
@@ -20,10 +21,11 @@ export default function (): {
     '.renovaterc.json': string;
     '.vscode/settings.json': string;
     'AGENTS.md': any;
-    'LICENSE.md': any;
-    'README.md': any;
     'eslint.config.ts': any;
     'eslint.lint-staged.config.ts': string;
+    'LICENSE.md': any;
     'package.json': string;
+    'README.md': any;
     'tsconfig.json': string;
 };
+export default _default;

package/dist/get-generated-files/index.js

@@ -17,8 +17,8 @@ import githubLabelsConfig from "./github-labels.js";
 import githubSyncLabelsConfig from "./github-sync-labels.js";
 import npmrc from "./npmrc.js";
 const resolver = createRequire(import.meta.url);
-export default function () {
-  const packageConfig = this.getPackageConfig();
+export default base => {
+  const packageConfig = base.getPackageConfig();
   return {
     ".commitlintrc.json": `${JSON.stringify(commitlintConfig, void 0, 2)}
 `,
@@ -33,7 +33,7 @@ export default function () {
     ".github/labels.yml": yamlStringify(sortKeys(githubLabelsConfig, {
       deep: true
     })),
-    ".github/workflows/build.yml": yamlStringify(sortKeys(this.getGithubWorkflowConfig(), {
+    ".github/workflows/build.yml": yamlStringify(sortKeys(base.getGithubWorkflowConfig(), {
       deep: true
     })),
     ".github/workflows/deprecated-dependencies.yml": yamlStringify(sortKeys(githubDeprecatedDependenciesConfig, {
@@ -42,34 +42,34 @@ export default function () {
     ".github/workflows/sync-labels.yml": yamlStringify(sortKeys(githubSyncLabelsConfig, {
       deep: true
     })),
-    ".github/workflows/sync-metadata.yml": yamlStringify(sortKeys(this.getGithubSyncMetadataConfig(), {
+    ".github/workflows/sync-metadata.yml": yamlStringify(sortKeys(base.getGithubSyncMetadataConfig(), {
       deep: true
     })),
-    ".gitignore": this.getGitignoreConfig().map(entry => `${entry}
+    ".gitignore": base.getGitignoreConfig().map(entry => `${entry}
 `).join(""),
-    ".gitpod.Dockerfile": this.getGitpodDockerfile(),
-    ".gitpod.yml": yamlStringify(this.getGitpodConfig()),
-    ".lintstagedrc.json": `${JSON.stringify(this.getLintStaged(), void 0, 2)}
+    ".gitpod.Dockerfile": base.getGitpodDockerfile(),
+    ".gitpod.yml": yamlStringify(base.getGitpodConfig()),
+    ".lintstagedrc.json": `${JSON.stringify(base.getLintStaged(), void 0, 2)}
 `,
     ".npmrc": stringifyIni(npmrc),
-    ".releaserc.json": `${JSON.stringify(this.getReleaseConfig(), void 0, 2)}
+    ".releaserc.json": `${JSON.stringify(base.getReleaseConfig(), void 0, 2)}
 `,
-    ".renovaterc.json": `${JSON.stringify(sortKeys(this.getRenovateConfig(), {
+    ".renovaterc.json": `${JSON.stringify(sortKeys(base.getRenovateConfig(), {
       deep: true
     }), void 0, 2)}
 `,
-    ".vscode/settings.json": `${JSON.stringify(this.getVscodeConfig(), void 0, 2)}
+    ".vscode/settings.json": `${JSON.stringify(base.getVscodeConfig(), void 0, 2)}
 `,
     "AGENTS.md": fs.readFileSync(resolver.resolve("./agents.md"), "utf8"),
-    "LICENSE.md": this.getLicenseString(),
-    "README.md": this.getReadmeString(),
-    "eslint.config.ts": this.getEslintConfig(),
+    "eslint.config.ts": base.getEslintConfig(),
     "eslint.lint-staged.config.ts": eslintLintStaged,
+    "LICENSE.md": base.getLicenseString(),
     "package.json": `${JSON.stringify(sortPackageJson(packageConfig), void 0, 2)}
 `,
-    "tsconfig.json": `${JSON.stringify(sortKeys(this.getTypescriptConfig(), {
+    "README.md": base.getReadmeString(),
+    "tsconfig.json": `${JSON.stringify(sortKeys(base.getTypescriptConfig(), {
       deep: true
     }), void 0, 2)}
 `
   };
-}
+};

package/dist/index.d.ts

@@ -1,20 +1,45 @@
 import type { Options as DepcheckOptions } from 'depcheck';
-import { type ResultPromise } from 'execa';
 import type GitHost from 'hosted-git-info';
 import type { Configuration as LintStagedConfig } from 'lint-staged';
 import type { PartialCommandObjectInObject } from 'make-cli';
 import type { RenovateConfig } from 'renovate/dist/config/types';
-import type { PackageJson, TsConfigJson } from 'type-fest';
+import type { ArrayTail, PackageJson, TsConfigJson } from 'type-fest';
+import checkUnknownFiles from './commands/check-unknown-files';
 import type { PartialCommandOptions } from './commands/command-options-input';
-type HandlerWithBase<TConfig extends Config = Config> = (this: Base<TConfig>, ...args: any[]) => any;
+import commit from './commands/commit';
+import depcheckMethod from './commands/depcheck';
+import lint from './commands/lint';
+import lintPackagejson from './commands/lint/lint-packagejson';
+import prepare from './commands/prepare';
+import test from './commands/test';
+import testDocker from './commands/test-docker';
+import testRaw from './commands/test-raw';
+import typecheck from './commands/typecheck';
+import verify from './commands/verify';
+import getGeneratedFiles from './get-generated-files';
+import getEditorIgnoreConfig from './get-generated-files/get-editor-ignore';
+import getEslintConfig from './get-generated-files/get-eslint';
+import getGithubSyncMetadataConfig from './get-generated-files/get-github-sync-metadata';
+import getGithubWorkflowConfig from './get-generated-files/get-github-workflow';
+import getGitignoreConfig from './get-generated-files/get-gitignore';
+import getGitpodConfig from './get-generated-files/get-gitpod';
+import getGitpodDockerfile from './get-generated-files/get-gitpod-dockerfile';
+import getLicenseString from './get-generated-files/get-license-string';
+import getLintStaged from './get-generated-files/get-lint-staged';
+import getPackageConfig from './get-generated-files/get-package-config';
+import getReadmeString from './get-generated-files/get-readme-string';
+import getReleaseConfig from './get-generated-files/get-release';
+import getRenovateConfig from './get-generated-files/get-renovate';
+import getTypescriptConfig from './get-generated-files/get-typescript';
+import getVscodeConfig from './get-generated-files/get-vscode';
+type HandlerWithBase<TConfig extends Config = Config> = (base: Base<TConfig>, ...arguments_: any[]) => any;
 type PartialCommandObjectInObjectWithBase<TConfig extends Config = Config> = Omit<PartialCommandObjectInObject, 'handler'> & {
-    handler: (this: Base<TConfig>, ...args: any[]) => any;
+    handler: (base: Base<TConfig>, ...arguments_: any[]) => any;
 };
 type PartialCommandInObjectWithBase<TConfig extends Config = Config> = PartialCommandObjectInObjectWithBase<TConfig> | HandlerWithBase<TConfig>;
 type Config = {
-    name?: string;
-    global: boolean;
     allowedMatches: string[];
+    codecovGraphToken: string | null;
     commands: Record<string, PartialCommandObjectInObjectWithBase>;
     depcheckConfig: Omit<DepcheckOptions, 'package'>;
     deployAssets: Array<{
@@ -23,41 +48,44 @@ type Config = {
     }>;
     deployEnv: Record<string, string>;
     deployPlugins: string[];
+    doppler: boolean;
     editorIgnore: string[];
+    eslintConfig: string;
     fetchGitHistory: boolean;
-    githubActionsTypecheckMemoryLimitMb: number | null;
     git?: GitHost;
+    githubActionsTypecheckMemoryLimitMb: number | null;
     gitignore: string[];
+    global: boolean;
     hasTypescriptConfigRootAlias: boolean;
+    isLockFileFixCommitType: boolean;
+    lint: <TConfig extends Config>(base: Base<TConfig>, options?: PartialCommandOptions) => unknown;
     lintStagedConfig: LintStagedConfig;
-    lint: (options?: PartialCommandOptions) => unknown;
-    typecheck: (options?: PartialCommandOptions) => unknown;
     macos: boolean;
-    minNodeVersion: number | null;
     maxNodeVersion: number | null;
+    minNodeVersion: number | null;
+    name?: string;
     nodeVersion: number;
+    npmPublish: boolean;
+    packageConfig: PackageJson;
     preDeploySteps: string[];
-    prepare: (options?: PartialCommandOptions) => unknown;
+    prepare: <TConfig extends Config>(base: Base<TConfig>, options?: PartialCommandOptions) => unknown;
     readmeInstallString: string;
+    renovateConfig: RenovateConfig;
     seeAlso: Array<{
         description: string;
         repository: string;
     }>;
     supportedNodeVersions: number[];
     syncKeywords: boolean;
+    testInContainer: boolean;
+    typecheck: <TConfig extends Config>(base: Base<TConfig>, options?: PartialCommandOptions) => unknown;
     typescriptConfig: TsConfigJson;
     windows: boolean;
-    testInContainer: boolean;
-    eslintConfig: string;
-    packageConfig: PackageJson;
-    renovateConfig: RenovateConfig;
-    isLockFileFixCommitType: boolean;
-    doppler: boolean;
 };
 type PartialConfigObject<TConfig extends Config = Config> = Omit<Partial<TConfig>, 'commands'> & {
     commands?: Record<string, PartialCommandInObjectWithBase<TConfig>>;
 };
-type PartialConfigOrFunction<TConfig extends Config = Config> = PartialConfigObject<TConfig> | ((this: Base<TConfig>, config: TConfig) => PartialConfigObject<TConfig>);
+type PartialConfigOrFunction<TConfig extends Config = Config> = PartialConfigObject<TConfig> | ((base: Base<TConfig>, config?: PartialConfigObject<TConfig>) => PartialConfigObject<TConfig>);
 type PartialConfig<TConfig extends Config = Config> = PartialConfigOrFunction<TConfig> | string | null;
 export declare const defineBaseConfig: <T>(configInput: T) => T;
 declare class Base<TConfig extends Config = Config> {
@@ -65,40 +93,200 @@ declare class Base<TConfig extends Config = Config> {
     packageConfig: PackageJson;
     cwd: string;
     generatedFiles: any;
-    commit(...args: any[]): ResultPromise;
-    lint(...args: any[]): ResultPromise;
-    lintPackagejson(...args: any[]): void;
-    typecheck(...args: any[]): ResultPromise;
-    verify(...args: any[]): ResultPromise;
-    prepare(...args: any[]): void;
-    test(...args: any[]): ResultPromise;
-    testRaw(...args: any[]): ResultPromise;
-    testDocker(...args: any[]): ResultPromise;
-    getPackageConfig(...args: any[]): any;
-    getGeneratedFiles(...args: any[]): any;
-    checkUnknownFiles(...args: any[]): void;
-    depcheck(...args: any[]): void;
-    getEditorIgnoreConfig(...args: any[]): any;
-    getEslintConfig(...args: any[]): any;
-    getGithubSyncMetadataConfig(...args: any[]): any;
-    getGithubWorkflowConfig(...args: any[]): any;
-    getGitignoreConfig(...args: any[]): any;
-    getGitpodConfig(...args: any[]): any;
-    getGitpodDockerfile(...args: any[]): any;
-    getLicenseString(...args: any[]): any;
-    getReadmeString(...args: any[]): any;
-    getReleaseConfig(...args: any[]): any;
-    getRenovateConfig(...args: any[]): any;
-    getVscodeConfig(...args: any[]): any;
-    getTypescriptConfig(...args: any[]): any;
-    getLintStaged(): any;
     constructor(configInput?: PartialConfig<TConfig>, { cwd }?: {
         cwd?: string | undefined;
     });
-    run<K extends keyof TConfig['commands'] & string>(name: K, ...args: Parameters<TConfig['commands'][K]['handler']>): ReturnType<TConfig['commands'][K]['handler']>;
+    commit(...arguments_: ArrayTail<Parameters<typeof commit>>): import("execa").ResultPromise<{
+        cwd: any;
+        stderr: any;
+        stdout: "pipe" | "inherit";
+    }>;
+    lint(...arguments_: ArrayTail<Parameters<typeof lint>>): Promise<import("execa").Result<any>>;
+    lintPackagejson(...arguments_: ArrayTail<Parameters<typeof lintPackagejson>>): void;
+    typecheck(...arguments_: ArrayTail<Parameters<typeof typecheck>>): Promise<import("execa").Result<any> | undefined>;
+    verify(...arguments_: ArrayTail<Parameters<typeof verify>>): Promise<void>;
+    prepare(...arguments_: ArrayTail<Parameters<typeof prepare>>): Promise<void>;
+    test(...arguments_: ArrayTail<Parameters<typeof test>>): any;
+    testRaw(...arguments_: ArrayTail<Parameters<typeof testRaw>>): import("execa").ResultPromise<{
+        cwd: any;
+        env: {
+            NODE_ENV: string;
+        };
+        stderr: any;
+        stdout: "pipe" | "inherit";
+    }>;
+    testDocker(...arguments_: ArrayTail<Parameters<typeof testDocker>>): Promise<import("execa").Result<{
+        cwd: any;
+        stderr: any;
+        stdout: "pipe" | "inherit";
+    }>>;
+    getPackageConfig(...arguments_: ArrayTail<Parameters<typeof getPackageConfig>>): any;
+    getGeneratedFiles(...arguments_: ArrayTail<Parameters<typeof getGeneratedFiles>>): {
+        '.commitlintrc.json': string;
+        '.cz.json': string;
+        '.devcontainer/devcontainer.json': string;
+        '.editorconfig': string;
+        '.gitattributes': string;
+        '.github/DEPRECATED_DEPENDENCIES_ISSUE_TEMPLATE.md': string;
+        '.github/FUNDING.yml': string;
+        '.github/labels.yml': string;
+        '.github/workflows/build.yml': string;
+        '.github/workflows/deprecated-dependencies.yml': string;
+        '.github/workflows/sync-labels.yml': string;
+        '.github/workflows/sync-metadata.yml': string;
+        '.gitignore': any;
+        '.gitpod.Dockerfile': any;
+        '.gitpod.yml': string;
+        '.lintstagedrc.json': string;
+        '.npmrc': any;
+        '.releaserc.json': string;
+        '.renovaterc.json': string;
+        '.vscode/settings.json': string;
+        'AGENTS.md': any;
+        'eslint.config.ts': any;
+        'eslint.lint-staged.config.ts': string;
+        'LICENSE.md': any;
+        'package.json': string;
+        'README.md': any;
+        'tsconfig.json': string;
+    };
+    checkUnknownFiles(...arguments_: ArrayTail<Parameters<typeof checkUnknownFiles>>): Promise<void>;
+    depcheck(...arguments_: ArrayTail<Parameters<typeof depcheckMethod>>): Promise<void>;
+    getEditorIgnoreConfig(...arguments_: ArrayTail<Parameters<typeof getEditorIgnoreConfig>>): any[];
+    getEslintConfig(...arguments_: ArrayTail<Parameters<typeof getEslintConfig>>): any;
+    getGithubSyncMetadataConfig(...arguments_: ArrayTail<Parameters<typeof getGithubSyncMetadataConfig>>): {
+        jobs: {
+            build: {
+                'runs-on': string;
+                steps: ({
+                    uses: any;
+                    with?: undefined;
+                } | {
+                    uses: any;
+                    with: {
+                        commitMessage: string;
+                        githubToken: string;
+                        syncKeywords?: boolean | undefined;
+                        approve: boolean;
+                    };
+                })[];
+            };
+        };
+        name: string;
+        on: {
+            schedule: {
+                cron: string;
+            }[];
+            workflow_dispatch: {};
+        };
+    };
+    getGithubWorkflowConfig(...arguments_: ArrayTail<Parameters<typeof getGithubWorkflowConfig>>): {
+        concurrency: {
+            'cancel-in-progress': boolean;
+            group: string;
+        };
+        jobs: {
+            release: {
+                needs: string;
+                'runs-on': string;
+                steps: any[];
+            };
+            test: {
+                'runs-on': string;
+                steps: any[];
+                strategy: {
+                    matrix: {
+                        include: {
+                            node: number;
+                            os: string;
+                        }[];
+                    };
+                };
+            };
+        } | {
+            build: {
+                if: string;
+                'runs-on': string;
+                steps: any[];
+            };
+        };
+        name: string;
+        on: {
+            pull_request: {};
+            push: {
+                branches: string[];
+            };
+        };
+        permissions: {
+            contents: string;
+            'id-token': string;
+            issues: string;
+            'pull-requests': string;
+        };
+    };
+    getGitignoreConfig(...arguments_: ArrayTail<Parameters<typeof getGitignoreConfig>>): any[];
+    getGitpodConfig(...arguments_: ArrayTail<Parameters<typeof getGitpodConfig>>): {
+        image: {
+            file: string;
+        };
+        tasks: {
+            before: string;
+            init: string;
+        }[];
+        vscode: {
+            extensions: string[];
+        };
+    };
+    getGitpodDockerfile(...arguments_: ArrayTail<Parameters<typeof getGitpodDockerfile>>): string;
+    getLicenseString(...arguments_: ArrayTail<Parameters<typeof getLicenseString>>): string;
+    getReadmeString(...arguments_: ArrayTail<Parameters<typeof getReadmeString>>): any;
+    getReleaseConfig(...arguments_: ArrayTail<Parameters<typeof getReleaseConfig>>): {
+        plugins: any[];
+    };
+    getRenovateConfig(...arguments_: ArrayTail<Parameters<typeof getRenovateConfig>>): any;
+    getVscodeConfig(...arguments_: ArrayTail<Parameters<typeof getVscodeConfig>>): {
+        'editor.tabSize': number;
+        'files.autoSave': string;
+        'files.exclude': {
+            [k: string]: any;
+        };
+        'workbench.editor.enablePreview': boolean;
+    };
+    getTypescriptConfig(...arguments_: ArrayTail<Parameters<typeof getTypescriptConfig>>): any;
+    getLintStaged(...arguments_: ArrayTail<Parameters<typeof getLintStaged>>): Record<string, string | string[]> | {
+        '*.{json,ts,vue}': string;
+    };
+    run<K extends keyof TConfig['commands'] & string>(name: K, ...arguments_: ArrayTail<Parameters<TConfig['commands'][K]['handler']>>): ReturnType<TConfig['commands'][K]['handler']>;
 }
 export { default as loadConfig } from './load-config';
 export { default as loadConfigSync } from './load-config-sync';
 export { Base };
 export type { Config, PartialConfig };
 export { type PartialCommandOptions } from './commands/command-options-input';
+export { default as checkUnknownFiles } from './commands/check-unknown-files';
+export { default as depcheck } from './commands/depcheck';
+export { default as commit } from './commands/commit';
+export { default as getEslintConfig } from './get-generated-files/get-eslint';
+export { default as getEditorIgnoreConfig } from './get-generated-files/get-editor-ignore';
+export { default as getGithubSyncMetadataConfig } from './get-generated-files/get-github-sync-metadata';
+export { default as getGeneratedFiles } from './get-generated-files';
+export { default as getGitignoreConfig } from './get-generated-files/get-gitignore';
+export { default as getGithubWorkflowConfig } from './get-generated-files/get-github-workflow';
+export { default as getGitpodDockerfile } from './get-generated-files/get-gitpod-dockerfile';
+export { default as getGitpodConfig } from './get-generated-files/get-gitpod';
+export { default as getLintStaged } from './get-generated-files/get-lint-staged';
+export { default as getLicenseString } from './get-generated-files/get-license-string';
+export { default as getReadmeString } from './get-generated-files/get-readme-string';
+export { default as getPackageConfig } from './get-generated-files/get-package-config';
+export { default as getRenovateConfig } from './get-generated-files/get-renovate';
+export { default as getReleaseConfig } from './get-generated-files/get-release';
+export { default as getVscodeConfig } from './get-generated-files/get-vscode';
+export { default as getTypescriptConfig } from './get-generated-files/get-typescript';
+export { default as lintPackagejson } from './commands/lint/lint-packagejson';
+export { default as lint } from './commands/lint';
+export { default as test } from './commands/test';
+export { default as prepare } from './commands/prepare';
+export { default as testRaw } from './commands/test-raw';
+export { default as testDocker } from './commands/test-docker';
+export { default as verify } from './commands/verify';
+export { default as typecheck } from './commands/typecheck';