jiek 1.0.0 → 1.0.1

package/dist/cli.d.cts

@@ -0,0 +1,112 @@
+import { OutputOptions } from 'rollup';
+
+type Mapping2ROO<K extends keyof OutputOptions> = OutputOptions[K] | {
+    js?: OutputOptions[K];
+    dts?: OutputOptions[K];
+};
+interface TemplateOptions {
+    /**
+     * When the user configures type: module, the generated output from entry points that don't
+     * have cts as a suffix will automatically include the CJS version.
+     * if it is not configured, and the generated output from entry points that do not have mts
+     * as a suffix will automatically include the ESM version.
+     *
+     * @default true
+     */
+    crossModuleConvertor?: boolean;
+    output?: {
+        /**
+         * @default true
+         *
+         * When minify is set to true, the output will with minified files.
+         * When minify is set to 'only-minify', the output will direct output minified files.
+         */
+        minify?: boolean | 'only-minify';
+        /**
+         * @default 'dist'
+         */
+        dir?: Mapping2ROO<'dir'>;
+        sourcemap?: Mapping2ROO<'sourcemap'>;
+        strict?: Mapping2ROO<'strict'>;
+    };
+}
+declare module 'jiek' {
+    interface Config {
+        build?: TemplateOptions & {
+            /**
+             * Whether to run in silent mode, only active when configured in the workspace root or cwd.
+             *
+             * @default false
+             */
+            silent?: boolean;
+        };
+    }
+}
+
+declare module 'jiek' {
+    type InitNamedFunction = (argument: string, paths: {
+        full: string;
+        relative: string;
+        basename?: string;
+    }) => [name?: string, path?: string];
+    type InitNamed = InitNamedFunction | {
+        [key: string]: string | InitNamedFunction;
+    };
+    interface Config {
+        init?: {
+            /**
+             * the package.json template file path or file content
+             *
+             * if it can be parsed as json, it will be parsed
+             * if it is a relative file path, it will be resolved to an absolute path based on the current working directory
+             * if it is an absolute file path, it will be used directly
+             * @default '.jiek.template.package.json'
+             */
+            template?: string;
+            /**
+             * the readme content
+             *
+             * $name will be replaced with the package name
+             * $license will be replaced with the license
+             */
+            readme?: string | ((ctx: {
+                dir: string;
+                packageJson: Record<string, any>;
+            }) => string);
+            /**
+             * the readme template file path
+             * @default '.jiek.template.readme.md'
+             */
+            readmeTemplate?: string;
+            bug?: {
+                /**
+                 * @default 'bug_report.yml'
+                 */
+                template?: string;
+                /**
+                 * @default ['bug']
+                 */
+                labels?: string[] | ((ctx: {
+                    name: string;
+                    dir: string;
+                }) => string[]);
+            };
+            named?: InitNamed;
+        };
+    }
+}
+
+declare module 'jiek' {
+    interface Config {
+        publish?: {
+            /**
+             * @default false
+             */
+            withSuffix?: boolean;
+            /**
+             * @default true
+             */
+            withSource?: boolean;
+        };
+    }
+}

package/dist/cli.d.ts

@@ -0,0 +1,112 @@
+import { OutputOptions } from 'rollup';
+
+type Mapping2ROO<K extends keyof OutputOptions> = OutputOptions[K] | {
+    js?: OutputOptions[K];
+    dts?: OutputOptions[K];
+};
+interface TemplateOptions {
+    /**
+     * When the user configures type: module, the generated output from entry points that don't
+     * have cts as a suffix will automatically include the CJS version.
+     * if it is not configured, and the generated output from entry points that do not have mts
+     * as a suffix will automatically include the ESM version.
+     *
+     * @default true
+     */
+    crossModuleConvertor?: boolean;
+    output?: {
+        /**
+         * @default true
+         *
+         * When minify is set to true, the output will with minified files.
+         * When minify is set to 'only-minify', the output will direct output minified files.
+         */
+        minify?: boolean | 'only-minify';
+        /**
+         * @default 'dist'
+         */
+        dir?: Mapping2ROO<'dir'>;
+        sourcemap?: Mapping2ROO<'sourcemap'>;
+        strict?: Mapping2ROO<'strict'>;
+    };
+}
+declare module 'jiek' {
+    interface Config {
+        build?: TemplateOptions & {
+            /**
+             * Whether to run in silent mode, only active when configured in the workspace root or cwd.
+             *
+             * @default false
+             */
+            silent?: boolean;
+        };
+    }
+}
+
+declare module 'jiek' {
+    type InitNamedFunction = (argument: string, paths: {
+        full: string;
+        relative: string;
+        basename?: string;
+    }) => [name?: string, path?: string];
+    type InitNamed = InitNamedFunction | {
+        [key: string]: string | InitNamedFunction;
+    };
+    interface Config {
+        init?: {
+            /**
+             * the package.json template file path or file content
+             *
+             * if it can be parsed as json, it will be parsed
+             * if it is a relative file path, it will be resolved to an absolute path based on the current working directory
+             * if it is an absolute file path, it will be used directly
+             * @default '.jiek.template.package.json'
+             */
+            template?: string;
+            /**
+             * the readme content
+             *
+             * $name will be replaced with the package name
+             * $license will be replaced with the license
+             */
+            readme?: string | ((ctx: {
+                dir: string;
+                packageJson: Record<string, any>;
+            }) => string);
+            /**
+             * the readme template file path
+             * @default '.jiek.template.readme.md'
+             */
+            readmeTemplate?: string;
+            bug?: {
+                /**
+                 * @default 'bug_report.yml'
+                 */
+                template?: string;
+                /**
+                 * @default ['bug']
+                 */
+                labels?: string[] | ((ctx: {
+                    name: string;
+                    dir: string;
+                }) => string[]);
+            };
+            named?: InitNamed;
+        };
+    }
+}
+
+declare module 'jiek' {
+    interface Config {
+        publish?: {
+            /**
+             * @default false
+             */
+            withSuffix?: boolean;
+            /**
+             * @default true
+             */
+            withSource?: boolean;
+        };
+    }
+}