jiek 0.4.5 → 0.4.7-alpha.1

package/README.md

@@ -1,5 +1,26 @@
 # Jiek
 
-A powerful and clever monorepo cli tool.
+为什么没有一个在 monorepo 下面足够现代又足够简单的构建工具呢？恭喜你发现了宝藏～
 
 ## Features
+
+### build
+
+写构建脚本一直不是一件简单的事情，那么怎么把一个复杂的事情变简单呢？我们回到需求的本身，那就是「定义什么便构建什么」。在这里我们用自然的方式来定义构建产物，而不需要去多写一行多余的代码。
+
+> 在这里你需要了解足够先进和现代的「[模块管理]()」以及「[导出策略]()」，在这里我们便是基于这俩点达成的一些自然而然的约定来实现的减轻负担。
+
+接下来我们可以一步步的来看看我们的构建工具是如何工作的。
+
+#### 定义入口
+
+#### 运行指令
+
+#### 个性化需求
+
+#### 幕后的故事
+
+一些关于本工具的设计思路和实现细节，不阅读也不会影响各位的使用，感兴趣的各位可以看看。
+
+- 入口的约定
+- 插件的抉择

package/bin/jiek.js

@@ -5,5 +5,6 @@ const path = require('node:path')
 if (fs.existsSync(path.join(__dirname, '../.jiek-dev-tag'))) {
   require('esbuild-register')
   require('../src/cli.ts')
-} else
+} else {
   require('../dist/cli.cjs')
+}

package/dist/cli.d.mts

@@ -0,0 +1,97 @@
+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;
+        };
+    }
+}

package/dist/cli.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.mts","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/cli.d.ts

@@ -1,2 +1,97 @@
+import { OutputOptions } from 'rollup';
 
-export {  }
+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;
+        };
+    }
+}

package/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sources":[],"sourcesContent":[],"names":[],"mappings":""}