feat(create-rslib): setup Node.js package templates (#319)

Author: chenjiahan

packages/create-rslib/package.json

@@ -31,6 +31,7 @@
     "create-rstack": "1.0.7"
   },
   "devDependencies": {
+    "@rslib/core": "workspace:*",
     "@rslib/tsconfig": "workspace:*",
     "@types/fs-extra": "^11.0.4",
     "@types/node": "~18.19.39",

packages/create-rslib/src/index.ts

@@ -13,15 +13,21 @@ const __dirname = path.dirname(fileURLToPath(import.meta.url));
 async function getTemplateName({ template }: Argv) {
   if (typeof template === 'string') {
     const pair = template.split('-');
-    const language = pair[1] ?? 'js';
-    const type = pair[0];
-    return `${type}-${language}`;
+    const lang = pair[pair.length - 1];
+    if (lang && ['js', 'ts'].includes(lang)) {
+      return template;
+    }
+    // default to ts
+    return `${template}-ts`;
   }
 
   const type = checkCancel<string>(
     await select({
       message: 'Select template',
-      options: [{ value: 'example', label: 'Example' }],
+      options: [
+        { value: 'node-dual', label: 'Node.js dual ESM/CJS package' },
+        { value: 'node-esm', label: 'Node.js pure ESM package' },
+      ],
     }),
   );
 
@@ -39,14 +45,14 @@ async function getTemplateName({ template }: Argv) {
 }
 
 function mapESLintTemplate(templateName: string) {
-  const language = templateName.split('-')[1];
+  const language = templateName.split('-').pop();
   return `vanilla-${language}` as ESLintTemplateName;
 }
 
 create({
   root: path.resolve(__dirname, '..'),
   name: 'rslib',
-  templates: ['example-js', 'example-ts'],
+  templates: ['node-dual-js', 'node-dual-ts', 'node-esm-js', 'node-esm-ts'],
   getTemplateName,
   mapESLintTemplate,
 });

packages/create-rslib/template-example-js/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "rslib-node-dual-js",
+  "version": "0.0.0",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "rslib build",
+    "dev": "rslib build --watch"
+  },
+  "devDependencies": {
+    "@rslib/core": "workspace:*"
+  }
+}

packages/create-rslib/template-example-js/rslib.config.mjs

@@ -0,0 +1,15 @@
+import { defineConfig } from '@rslib/core';
+
+export default defineConfig({
+  lib: [
+    {
+      format: 'esm',
+      syntax: 'es2021',
+    },
+    {
+      format: 'cjs',
+      syntax: 'es2021',
+    },
+  ],
+  output: { target: 'node' },
+});

packages/create-rslib/template-example-ts/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "rslib-node-dual-ts",
+  "version": "0.0.0",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "rslib build",
+    "dev": "rslib build --watch"
+  },
+  "devDependencies": {
+    "@rslib/core": "workspace:*",
+    "typescript": "^5.6.3"
+  }
+}

packages/create-rslib/template-example-ts/rslib.config.ts

@@ -0,0 +1,16 @@
+import { defineConfig } from '@rslib/core';
+
+export default defineConfig({
+  lib: [
+    {
+      format: 'esm',
+      syntax: 'es2021',
+      dts: {},
+    },
+    {
+      format: 'cjs',
+      syntax: 'es2021',
+    },
+  ],
+  output: { target: 'node' },
+});

packages/create-rslib/template-node-dual-js/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "rslib-node-esm-js",
+  "version": "0.0.0",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js"
+    }
+  },
+  "module": "./dist/index.js",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "rslib build",
+    "dev": "rslib build --watch"
+  },
+  "devDependencies": {
+    "@rslib/core": "workspace:*"
+  }
+}

packages/create-rslib/template-node-dual-js/rslib.config.mjs

@@ -0,0 +1,11 @@
+import { defineConfig } from '@rslib/core';
+
+export default defineConfig({
+  lib: [
+    {
+      format: 'esm',
+      syntax: 'es2021',
+    },
+  ],
+  output: { target: 'node' },
+});

packages/create-rslib/template-example-js/src/index.js renamed to packages/create-rslib/template-node-dual-js/src/index.js

@@ -0,0 +1,3 @@
+export function example() {
+  return 'hello world';
+}

packages/create-rslib/template-node-dual-ts/package.json

@@ -0,0 +1,24 @@
+{
+  "name": "rslib-node-esm-ts",
+  "version": "0.0.0",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "rslib build",
+    "dev": "rslib build --watch"
+  },
+  "devDependencies": {
+    "@rslib/core": "workspace:*",
+    "typescript": "^5.6.3"
+  }
+}

packages/create-rslib/template-node-dual-ts/rslib.config.ts

@@ -0,0 +1,12 @@
+import { defineConfig } from '@rslib/core';
+
+export default defineConfig({
+  lib: [
+    {
+      format: 'esm',
+      syntax: 'es2021',
+      dts: {},
+    },
+  ],
+  output: { target: 'node' },
+});

packages/create-rslib/template-example-ts/src/index.ts renamed to packages/create-rslib/template-node-dual-ts/src/index.ts

@@ -0,0 +1,3 @@
+export function example(): string {
+  return 'hello world';
+}

packages/create-rslib/template-example-ts/tsconfig.json renamed to packages/create-rslib/template-node-dual-ts/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "ES2021",
+    "lib": ["DOM", "ES2021"],
+    "module": "ESNext",
+    "noEmit": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "isolatedModules": true,
+    "resolveJsonModule": true,
+    "moduleResolution": "bundler",
+    "useDefineForClassFields": true,
+    "allowImportingTsExtensions": true
+  },
+  "include": ["src"]
+}

packages/create-rslib/template-node-esm-js/package.json

@@ -3,28 +3,36 @@ import { join } from 'node:path';
 import { expect, test } from 'vitest';
 import { createAndValidate } from './helper';
 
-test('should create example-js project as expected', async () => {
-  createAndValidate(__dirname, 'example-js');
+test('should create node-dual-js project as expected', async () => {
+  createAndValidate(__dirname, 'node-dual-js');
 });
 
-test('should create example-ts project as expected', async () => {
-  createAndValidate(__dirname, 'example-ts');
+test('should create node-dual-ts project as expected', async () => {
+  createAndValidate(__dirname, 'node-dual-ts');
+});
+
+test('should create node-esm-js project as expected', async () => {
+  createAndValidate(__dirname, 'node-esm-js');
+});
+
+test('should create node-esm-ts project as expected', async () => {
+  createAndValidate(__dirname, 'node-esm-ts');
 });
 
 test('should allow to create project in sub dir', async () => {
-  createAndValidate(__dirname, 'example', {
+  createAndValidate(__dirname, 'node-esm-js', {
     name: 'test-temp-dir/rslib-project',
   });
 });
 
 test('should allow to create project in relative dir', async () => {
-  createAndValidate(__dirname, 'example', {
+  createAndValidate(__dirname, 'node-esm-js', {
     name: './test-temp-relative-dir',
   });
 });
 
 test('should create project with eslint as expected', async () => {
-  const { dir, pkgJson, clean } = createAndValidate(__dirname, 'example', {
+  const { dir, pkgJson, clean } = createAndValidate(__dirname, 'node-esm-js', {
     name: 'test-temp-eslint',
     tools: ['eslint'],
     clean: false,
@@ -35,7 +43,7 @@ test('should create project with eslint as expected', async () => {
 });
 
 test('should create project with prettier as expected', async () => {
-  const { dir, pkgJson, clean } = createAndValidate(__dirname, 'example', {
+  const { dir, pkgJson, clean } = createAndValidate(__dirname, 'node-esm-js', {
     name: 'test-temp-prettier',
     tools: ['prettier'],
     clean: false,
@@ -46,7 +54,7 @@ test('should create project with prettier as expected', async () => {
 });
 
 test('should create project with eslint and prettier as expected', async () => {
-  const { dir, pkgJson, clean } = createAndValidate(__dirname, 'example', {
+  const { dir, pkgJson, clean } = createAndValidate(__dirname, 'node-esm-js', {
     name: 'test-temp-eslint-prettier',
     tools: ['eslint', 'prettier'],
     clean: false,
@@ -59,7 +67,7 @@ test('should create project with eslint and prettier as expected', async () => {
 });
 
 test('should create project with biome as expected', async () => {
-  const { dir, pkgJson, clean } = createAndValidate(__dirname, 'example', {
+  const { dir, pkgJson, clean } = createAndValidate(__dirname, 'node-esm-js', {
     name: 'test-temp-eslint',
     tools: ['biome'],
     clean: false,

packages/create-rslib/template-node-esm-js/rslib.config.mjs

@@ -38,6 +38,17 @@ import { PackageManagerTabs } from '@theme';
 
 Then follow the prompts to complete the operation.
 
+### Templates
+
+When creating a project, you can choose from the following templates provided by `create-rslib`:
+
+| Template     | Description                                        |
+| ------------ | -------------------------------------------------- |
+| node-dual-js | Node.js dual ESM/CJS package                       |
+| node-dual-ts | Node.js dual ESM/CJS package written in TypeScript |
+| node-esm-js  | Node.js pure ESM package                           |
+| node-esm-ts  | Node.js pure ESM package written in TypeScript     |
+
 ### Optional Tools
 
 `create-rslib` can help you set up some commonly used tools, including [Biome](https://github.com/biomejs/biome), [ESLint](https://github.com/eslint/eslint), and [prettier](https://github.com/prettier/prettier). You can use the arrow keys and the space bar to make your selections. If you don't need these tools, you can simply press Enter to skip.