chore: fix git initialization prompt message (grammar) (#155)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

.github/workflows/continuous-integration.yml

@@ -42,7 +42,7 @@ jobs:
       - name: Set up Node.js
         uses: actions/setup-node@1a4442cacd436585916779262731d5b162bc6ec7 # v3
         with:
-          node-version: 17
+          node-version: 20
 
       - name: Install Node.js dependencies
         run: npm i && npm run build

CHANGELOG.md

@@ -2,6 +2,60 @@
 
 All notable changes to this project will be documented in this file.
 
+## [1.4.0](https://github.com/sern-handler/cli/compare/v1.3.5...v1.4.0) (2025-02-07)
+
+
+### Features
+
+* watch command execute on successful build ([#151](https://github.com/sern-handler/cli/issues/151)) ([1695956](https://github.com/sern-handler/cli/commit/1695956350a55bb4a28839b427d1bf46cf518b01))
+
+## [1.3.5](https://github.com/sern-handler/cli/compare/v1.3.4...v1.3.5) (2025-01-29)
+
+
+### Bug Fixes
+
+* Update Dockerfile.TS.sern ([#149](https://github.com/sern-handler/cli/issues/149)) ([fca3c76](https://github.com/sern-handler/cli/commit/fca3c7601604215af9b6d66a137370064ae656e1))
+
+## [1.3.4](https://github.com/sern-handler/cli/compare/v1.3.3...v1.3.4) (2025-01-22)
+
+
+### Bug Fixes
+
+* tsconfig generator ([#145](https://github.com/sern-handler/cli/issues/145)) ([23d70c6](https://github.com/sern-handler/cli/commit/23d70c6e03860d1a69e3bffedd6910aba82071ab))
+
+## [1.3.3](https://github.com/sern-handler/cli/compare/v1.3.2...v1.3.3) (2024-08-07)
+
+
+### Bug Fixes
+
+* bunpnpminstall ([9c2d6d7](https://github.com/sern-handler/cli/commit/9c2d6d7389c41a071ab86570cebf987b02bbf450))
+
+## [1.3.2](https://github.com/sern-handler/cli/compare/v1.3.1...v1.3.2) (2024-07-31)
+
+
+### Bug Fixes
+
+* make tsconfig work with comments/trailing commas ([#142](https://github.com/sern-handler/cli/issues/142)) ([53ca446](https://github.com/sern-handler/cli/commit/53ca446a38076ed7b165dbbb41f346f028b7e394))
+
+## [1.3.1](https://github.com/sern-handler/cli/compare/v1.3.0...v1.3.1) (2024-07-27)
+
+
+### Miscellaneous Chores
+
+* release 1.3.1 ([2bb169f](https://github.com/sern-handler/cli/commit/2bb169f600172af8c8316b6c9420684a4de34e0d))
+
+## [1.3.0](https://github.com/sern-handler/cli/compare/v1.2.1...v1.3.0) (2024-07-27)
+
+
+### Features
+
+* plugin, no prompt, bug fixes ([#139](https://github.com/sern-handler/cli/issues/139)) ([20364fa](https://github.com/sern-handler/cli/commit/20364fa20d1f3bf70a1c0cfefbc1d6c9365a4925))
+
+
+### Bug Fixes
+
+* fix publish command for bun & pnpm ([#137](https://github.com/sern-handler/cli/issues/137)) ([d581142](https://github.com/sern-handler/cli/commit/d581142f082ed888036e58aa33e9d88d84d34c2f))
+
 ## [1.2.1](https://github.com/sern-handler/cli/compare/v1.2.0...v1.2.1) (2024-02-08)
 
 

README.md

@@ -61,3 +61,23 @@ Run `npm create @sern/bot` for an interactive setup on a brand new project using
 
 sern runs on your plugins. Contribute to our [repository](https://github.com/sern-handler/awesome-plugins) and then install the plugins via our cli! <br>
 Run `sern plugins` to see all installable plugins.
+
+
+## Development
+
+```sh
+git clone https://github.com/sern-handler/cli.git
+```
+## insall i
+```sh 
+npm i 
+```
+## build it
+```sh 
+npm run build
+```
+## make it usable globally
+- if sern is installed globally already, you may need to uninstall it.
+```sh 
+npm link
+```

package.json

@@ -1,63 +1,63 @@
 {
-    "name": "@sern/cli",
-    "version": "1.2.1",
-    "description": "Official CLI for @sern/handler",
-    "exports": "./dist/index.js",
-    "bin": {
-        "sern": "./dist/index.js"
-    },
-    "type": "module",
-    "scripts": {
-        "test": "echo \"Error: no test specified\" && exit 1",
-        "format": "prettier --check .",
-        "fix": "prettier --write .",
-        "build": "tsup",
-        "watch": "tsup --watch"
-    },
-    "repository": {
-        "type": "git",
-        "url": "git+https://github.com/sern-handler/cli.git"
-    },
-    "keywords": [
-        "cli",
-        "discord",
-        "discord.js",
-        "sern",
-        "sern-handler"
-    ],
-    "author": "EvolutionX",
-    "license": "MIT",
-    "bugs": {
-        "url": "https://github.com/sern-handler/cli/issues"
-    },
-    "homepage": "https://sern.dev",
-    "dependencies": {
-        "@esbuild-kit/cjs-loader": "^2.4.2",
-        "@esbuild-kit/esm-loader": "^2.5.5",
-        "colorette": "2.0.20",
-        "commander": "11.0.0",
-        "dotenv": "^16.3.1",
-        "esbuild": "^0.19.1",
-        "execa": "7.2.0",
-        "find-up": "6.3.0",
-        "glob": "^10.3.3",
-        "ora": "6.3.1",
-        "prompts": "2.4.2",
-        "undici": "5.23.0"
-    },
-    "devDependencies": {
-        "@babel/parser": "^7.22.5",
-        "@favware/npm-deprecate": "1.0.7",
-        "@types/prompts": "2.4.4",
-        "prettier": "2.8.8",
-        "tsup": "^6.7.0",
-        "typescript": "5.2.2"
-    },
-    "engines": {
-        "node": ">= 18.16.x"
-    },
-    "publishConfig": {
-        "registry": "https://registry.npmjs.org/",
-        "access": "public"
-    }
+  "name": "@sern/cli",
+  "version": "1.4.1",
+  "description": "Official CLI for @sern/handler",
+  "exports": "./dist/index.js",
+  "bin": {
+    "sern": "./dist/index.js"
+  },
+  "type": "module",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "format": "prettier --check .",
+    "fix": "prettier --write .",
+    "build": "tsup",
+    "watch": "tsup --watch"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sern-handler/cli.git"
+  },
+  "keywords": [
+    "cli",
+    "discord",
+    "discord.js",
+    "sern",
+    "sern-handler"
+  ],
+  "author": "EvolutionX",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/sern-handler/cli/issues"
+  },
+  "homepage": "https://sern.dev",
+  "dependencies": {
+    "@esbuild-kit/cjs-loader": "^2.4.2",
+    "@esbuild-kit/esm-loader": "^2.5.5",
+    "colorette": "2.0.20",
+    "commander": "11.0.0",
+    "dotenv": "^16.3.1",
+    "esbuild": "^0.19.1",
+    "execa": "7.2.0",
+    "find-up": "6.3.0",
+    "glob": "^10.3.3",
+    "ora": "6.3.1",
+    "prompts": "2.4.2",
+    "undici": "5.23.0"
+  },
+  "devDependencies": {
+    "@babel/parser": "^7.22.5",
+    "@favware/npm-deprecate": "1.0.7",
+    "@types/prompts": "2.4.4",
+    "prettier": "2.8.8",
+    "tsup": "^6.7.0",
+    "typescript": "5.2.2"
+  },
+  "engines": {
+    "node": ">= 18.16.x"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  }
 }

src/commands/build.ts

@@ -7,9 +7,12 @@ import assert from 'node:assert';
 import defaultEsbuild from '../utilities/defaultEsbuildConfig';
 import { require } from '../utilities/require';
 import { pathExists, pathExistsSync } from 'find-up';
-import { mkdir, writeFile, readFile } from 'fs/promises';
+import { mkdir, writeFile } from 'fs/promises';
 import * as Preprocessor from '../utilities/preprocessor';
 import { bold, magentaBright } from 'colorette';
+import { parseTsConfig } from '../utilities/parseTsconfig';
+import { execa, type ExecaChildProcess } from 'execa';
+import { InvalidArgumentError } from 'commander';
 
 const VALID_EXTENSIONS = ['.ts', '.js' ];
 
@@ -43,38 +46,112 @@ type BuildOptions = {
      * default to .env.
      */
     env?: string;
+    /**
+     * flag: default false
+     */
+    sourcemap?: boolean;
+
+    watch?: {
+        /**
+         * command to run.
+         * defaults to your package
+         * manager's start command.
+         */
+        command?: string;
+    }
+    
 };
 
 const CommandHandlerPlugin = (buildConfig: Partial<BuildOptions>, ambientFilePath: string, sernTsConfigPath: string) => {
     return {
-        name: "commandhandler",
+        name: "commandHandler",
         setup(build) {
 
             const options = build.initialOptions
             const defVersion = () => JSON.stringify(require(p.resolve('package.json')).version);
+            // should fix a type error
             options.define = { 
-                ...buildConfig.define ?? {},
+                ...(buildConfig.define ?? {}),
                 __DEV__: `${buildConfig.mode === 'development'}`,
                 __PROD__: `${buildConfig.mode === 'production'}`,
                 __VERSION__: `${buildConfig.defineVersion ? `${defVersion()}` : 'undefined'}`
-            } ?? {} 
+            }
             Preprocessor.writeTsConfig(buildConfig.format!, sernTsConfigPath, writeFile);
             Preprocessor.writeAmbientFile(ambientFilePath, options.define!, writeFile);
             
         }
     } as esbuild.Plugin
 }
-const resolveBuildConfig = (path: string|undefined, language: string) => {
-    if(language === 'javascript') {
+const CommandOnEndPlugin = (watching: boolean, watchCommand?: string) => {
+    // for some reason it runs the command twice on first build
+    let isFirstBuild = true;
+    let currentProcess: ExecaChildProcess | null = null;
+    let restartTimeout: NodeJS.Timeout | null = null;
+    return {
+        name: 'watchRunCommand',
+        setup(build: esbuild.PluginBuild) {
+            build.onEnd(async (result) => {
+                if (!watching || result.errors.length !== 0) return;
+                if (isFirstBuild === true) {
+                    isFirstBuild = false;
+                    return;
+                }
+                if (watchCommand === '') {
+                    console.log('[watch] no command provided, skipping');
+                    return;
+                }
+
+                if (currentProcess) {
+                    console.log('[watch] stopping previous process...');
+                    currentProcess.cancel()
+                    currentProcess = null;
+                }
+
+                const cmd = watchCommand || (() => {
+                    if (pathExistsSync('package-lock.json')) return 'npm start';
+                    if (pathExistsSync('yarn.lock')) return 'yarn start';
+                    if (pathExistsSync('pnpm-lock.yaml')) return 'pnpm start';
+                    if (pathExistsSync('bun.lockb')) return 'bun start';
+                    if (pathExistsSync('bun.lock')) return 'bun start';
+
+                    throw new Error('[watch] default package manager start command not found');
+                })();
+
+                // Clear any pending restart
+                if (restartTimeout) clearTimeout(restartTimeout);
+
+                console.log('[watch] debouncing command for 1.5 seconds...');
+                
+                // Set new debounced timeout
+                restartTimeout = setTimeout(() => {
+                    console.log(`[watch] running command: ${cmd}`);
+                    currentProcess = execa(cmd, { stdio: 'inherit', shell: true });
+                    currentProcess.catch(error => {
+                        if (error.isCanceled) return;
+                        console.error(`[watch] command execution error: ${error.message}`);
+                    });
+                }, 1500);
+            });
+        }
+    } as esbuild.Plugin;
+};
+const resolveBuildConfig = (path: string | undefined, language: string) => {
+    if (language === 'javascript') {
         return path ?? 'jsconfig.json'
     }
     return path ?? 'tsconfig.json'
 }
 
 export async function build(options: Record<string, any>) {
+    //console.log(options)
     if (!options.supressWarnings) {
         console.info(`${magentaBright('EXPERIMENTAL')}: This API has not been stabilized. add -W or --suppress-warnings flag to suppress`);
     }
+    // if watch was not enabled and watchCommand is present
+    if(!options.watch && options.watchCommand) {
+        throw new InvalidArgumentError("enable watch to use --watch-command")
+    }
+    
     const sernConfig = await getConfig();
     let buildConfig: BuildOptions; 
     const buildConfigPath = p.resolve(options.project ?? 'sern.build.js');
@@ -84,27 +161,40 @@ export async function build(options: Record<string, any>) {
         format: options.format ?? 'esm',
         mode: options.mode ?? 'development',
         dropLabels: [],
+        sourcemap: options.sourceMaps,
         tsconfig: resolveBuildConfig(options.tsconfig, sernConfig.language),
         env: options.env ?? '.env',
-        include: []
+        include: [],
+        watch: {
+            command: options.watchCommand
+        }
     };
+
+    // merging configuration with sern.build.js, if exists buildConfigPath 
     if (pathExistsSync(buildConfigPath)) {
-        //throwable, buildConfigPath may not exist
-        buildConfig = { ...defaultBuildConfig, ...(await import('file:///' + buildConfigPath)).default };
+        let fileConfig; 
+        try { fileConfig=await import('file:///' + buildConfigPath).then(r=>r.default) }
+        catch(e) { 
+            console.error("Could not find buildConfigPath")
+            throw e;
+        }
+        //throwable, buildConfigPath may not exist, todo, merge
+        buildConfig = { ...defaultBuildConfig, ...fileConfig };
     } else {
         buildConfig = defaultBuildConfig;
         console.log('No build config found, defaulting');
     }
+
     configDotenv({ path: buildConfig.env  });
     
     if (process.env.NODE_ENV) {
         buildConfig.mode = process.env.NODE_ENV as 'production' | 'development';
         console.log(magentaBright('NODE_ENV:'), 'Found NODE_ENV variable, setting `mode` to this.');
     }
-    assert(buildConfig.mode === 'development' || buildConfig.mode === 'production', 'Mode is not `production` or `development`');
+    assert(buildConfig.mode === 'development' || buildConfig.mode === 'production', 'NODE_ENV is not `production` or `development`');
     try {
-        let config = JSON.parse(await readFile(buildConfig.tsconfig!, 'utf8'));
-        config.extends && console.warn("Extend the generated tsconfig")
+        let config = await parseTsConfig(buildConfig.tsconfig!);
+        config?.extends && console.warn("Extend the generated tsconfig")
     } catch(e) {
          console.error("no tsconfig / jsconfig found");
          console.error(`Please create a ${sernConfig.language === 'javascript' ? 'jsconfig.json' : 'tsconfig.json' }`);
@@ -119,9 +209,10 @@ export async function build(options: Record<string, any>) {
     console.log(' ', magentaBright('mode'), buildConfig.mode);
     console.log(' ', magentaBright('tsconfig'), buildConfig.tsconfig);
     console.log(' ', magentaBright('env'), buildConfig.env);
+    console.log(' ', magentaBright('sourceMaps'), buildConfig.sourcemap);
 
     const sernDir = p.resolve('.sern'),
-          [ambientFilePath, sernTsConfigPath, genDir] = 
+          [ambientFilePath, sernTsConfigPath, genDir] = // resolves the file paths in the .sern dir
           ['ambient.d.ts', 'tsconfig.json', 'generated'].map(f => p.resolve(sernDir, f));
 
     if (!(await pathExists(genDir))) {
@@ -137,13 +228,17 @@ export async function build(options: Record<string, any>) {
     //https://esbuild.github.io/content-types/#tsconfig-json
     const ctx = await esbuild.context({
         entryPoints,
-        plugins: [CommandHandlerPlugin(buildConfig, ambientFilePath, sernTsConfigPath)],
+        plugins: [
+            CommandHandlerPlugin(buildConfig, ambientFilePath, sernTsConfigPath),
+            CommandOnEndPlugin(options.watch, buildConfig.watch?.command)
+        ],
+        sourcemap: buildConfig.sourcemap,
         ...defaultEsbuild(buildConfig.format!, buildConfig.tsconfig),
         dropLabels: [buildConfig.mode === 'production' ? '__DEV__' : '__PROD__', ...buildConfig.dropLabels!],
     });
 
     await ctx.rebuild()
-    if(options.watch) {
+    if (options.watch) {
         await ctx.watch()
     } else {
         await ctx.dispose()

src/commands/publish.ts

@@ -11,6 +11,7 @@ export async function publish(commandDir: string | undefined, args: Partial<Publ
     // pass in args into the command.
     const rootPath = new URL('../', import.meta.url),
         publishScript = new URL('../dist/create-publish.js', rootPath);
+
     // assign args.import to empty array if non existent
     args.import ??= [];
 
@@ -18,13 +19,14 @@ export async function publish(commandDir: string | undefined, args: Partial<Publ
 
     const isBunOrPnpm = rootPath.pathname.includes('.bun') || rootPath.pathname.includes('.pnpm');
 
-    const dotenvLocation = new URL(`${isBunOrPnpm ? '../../' : '../'}node_modules/dotenv/config.js`, rootPath),
-        esmLoader = new URL(`${isBunOrPnpm ? '../../' : '../'}node_modules/@esbuild-kit/esm-loader/dist/index.js`, rootPath);
+    const esmLoader = new URL(`${isBunOrPnpm ? '../../' : '../'}node_modules/@esbuild-kit/esm-loader/dist/index.js`, rootPath);
+
+    await import('dotenv/config');
 
     // We dynamically load the create-publish script in a child process so that we can pass the special
     // loader flag to require typescript files
     const command = fork(fileURLToPath(publishScript), [], {
-        execArgv: ['--loader', esmLoader.toString(), '-r', fileURLToPath(dotenvLocation), '--no-warnings'],
+        execArgv: ['--loader', esmLoader.toString(), '--no-warnings'],
     });
     // send paths object so we dont have to recalculate it in script
     command.send({ config, preloads: args.import, commandDir });

src/index.ts

@@ -52,24 +52,17 @@ program //
             .option('-y, --yes', "Say yes to all prompts")
             .option('-e, --env [path]', "Supply a path to a .env")
             .action(async (...args) => importDynamic('command-clear.js').then((m) => m.commandClear(...args))));
-program
-    .command('app')
-    .description('manage your discord application')
-    .addCommand(
-        new Command('update')
-            .description("Refresh your discord application.")
-            .option('-W --suppress-warnings', 'suppress experimental warning')
-            .action(async (...args) => importDynamic('app-update.js').then(m => m.appUpdate(...args))))
-
 program
     .command('build')
     .description('Build your bot')
     .option('-f --format [fmt]', 'The module system of your application. `cjs` or `esm`', 'esm')
     .option('-m --mode [mode]', 'the mode for sern to build in. `production` or `development`', 'development')
     .option('-w --watch')
+    .option('--watch-command [cmd]', 'the command for sern to watch. if watch is not enabled, an error is thrown', '')
     .option('-W --suppress-warnings', 'suppress experimental warning')
     .option('-p --project [filePath]', 'build with the provided sern.build file')
     .option('-e --env', 'path to .env file')
+    .option('--source-maps', 'Whether to add source-maps to configuration', false)
     .option('--tsconfig [filePath]', 'Use this tsconfig')
     .action(async (...args) => importDynamic('build.js').then((m) => m.build(...args)));
 

src/prompts/init.ts

@@ -49,7 +49,7 @@ export const npmInit: PromptObject = {
 export const gitInit: PromptObject = {
     name: 'gitinit',
     type: 'confirm',
-    message: `Do you want to ${blueBright('me')} to initialize git?`,
+    message: `Do you want ${blueBright('me')} to initialize git?`,
     initial: true,
 };
 

src/utilities/edits.ts

@@ -1,6 +1,7 @@
 import { findUp } from 'find-up';
 import { readFile, rename, writeFile } from 'node:fs/promises';
 import { fromCwd } from './fromCwd.js';
+import { parseTsConfig } from './parseTsconfig.js';
 
 /**
  * It takes a string, finds the package.json file in the directory of the string, and changes the name
@@ -61,10 +62,12 @@ export async function editDirs(
     });
 
     if (tsconfig) {
-        const output = JSON.parse(await readFile(tsconfig, 'utf8'));
+        const output = await parseTsConfig(tsconfig);
         if (!output) throw new Error("Can't read your tsconfig.json.");
+        if (!output.compilerOptions) throw new Error("Can't find compilerOptions in your tsconfig.json.");
         output.compilerOptions.rootDir = srcName;
 
+        // This will strip comments/trailing commas from the tsconfig.json file
         await writeFile(tsconfig, JSON.stringify(output, null, 2));
     }
 

src/utilities/parseTsconfig.ts

@@ -0,0 +1,50 @@
+import { resolve } from 'node:path';
+import { readFile } from 'node:fs/promises';
+
+interface CompilerOptions {
+    target: string;
+    module: string;
+    lib: string[];
+    allowJs: boolean;
+    checkJs: boolean;
+    jsx: string;
+    declaration: boolean;
+    sourceMap: boolean;
+    outDir: string;
+    rootDir: string;
+    strict: boolean;
+    esModuleInterop: boolean;
+    forceConsistentCasingInFileNames: boolean;
+    noEmit: boolean;
+    importHelpers: boolean;
+    isolatedModules: boolean;
+    moduleResolution: string;
+    resolveJsonModule: boolean;
+    noEmitHelpers: boolean;
+}
+
+interface TsConfig {
+    compilerOptions: CompilerOptions;
+    files: string[];
+    include: string[];
+    exclude: string[];
+    extends: string;
+}
+
+const cleanJson = (json: string) =>
+    json
+        .replace(/\/\/.*$/gm, '')
+        .replace(/\/\*[\s\S]*?\*\//gm, '')
+        .replace(/,\s*([}\]])/g, '$1');
+
+export const parseTsConfig = async (path: string) => {
+    const absPath = resolve(path);
+    const fileContent = await readFile(absPath, 'utf-8');
+    const cleanContent = cleanJson(fileContent);
+
+    try {
+        return JSON.parse(cleanContent) as Partial<TsConfig>;
+    } catch (e) {
+        return null;
+    }
+};

src/utilities/preprocessor.ts

@@ -41,7 +41,7 @@ const writeTsConfig = async (format: 'cjs' | 'esm', configPath: string, fw: File
         compilerOptions: {
             //module determines top level await. CJS doesn't have that abliity afaik
             module: format === 'cjs' ? 'node' : 'esnext',
-            moduleResolution: 'node16',
+            moduleResolution: 'node',
             strict: true,
             skipLibCheck: true,
             target: 'esnext',

templates/extra/Dockerfile.JS.sern

@@ -1,5 +1,7 @@
 FROM node:latest
 
+RUN npm install -g @sern/cli
+
 WORKDIR /app
 
 COPY package.json ./
@@ -8,4 +10,6 @@ RUN npm install
 
 COPY . .
 
-CMD node src/index.js
+RUN sern build
+
+CMD node .

templates/extra/Dockerfile.TS.sern

@@ -1,15 +1,15 @@
 FROM node:latest
 
+RUN npm install -g @sern/cli typescript@latest
+
 WORKDIR /app
 
 COPY package.json ./
 
 RUN npm install
 
-RUN npm install -D typescript
-
 COPY . .
 
-RUN tsc --build || npx -p typescript tsc --build
+RUN sern build
 
 CMD node dist/index.js