6 Commits
v1.3.4 ... main

Author SHA1 Message Date
Peter-MJ-Parker
2e66d6cfad chore: fix git initialization prompt message (grammar) (#155)
Some checks failed
Continuous Delivery / Publishing Dev (push) Has been cancelled
Continuous Integration / Testing (push) Has been cancelled
CodeQL / Analyze (javascript) (push) Failing after 6m28s
NPM Auto Deprecate / NPM Auto Deprecate (push) Successful in 3m5s
2025-07-28 20:19:31 +05:30
github-actions[bot]
58677cc15d chore(main): release 1.4.0 (#152)
Some checks failed
CodeQL / Analyze (javascript) (push) Has been cancelled
Continuous Delivery / Publishing Dev (push) Has been cancelled
Continuous Integration / Testing (push) Has been cancelled
NPM Auto Deprecate / NPM Auto Deprecate (push) Has been cancelled
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-02-06 22:17:01 -06:00
1695956350 feat: watch command execute on successful build (#151)
* feat: watch command execute on successful build

* chore: clarify comment

* chore: respect casing

* refactor: convert to camelcase

* feat: add timeout

* addwatchcommandtocli

---------

Co-authored-by: Jacob Nguyen <76754747+jacoobes@users.noreply.github.com>
2025-02-06 22:13:35 -06:00
github-actions[bot]
6798a762c7 chore(main): release 1.3.5 (#150)
Some checks failed
CodeQL / Analyze (javascript) (push) Has been cancelled
Continuous Delivery / Publishing Dev (push) Has been cancelled
Continuous Integration / Testing (push) Has been cancelled
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2025-01-28 22:00:38 -06:00
Jacob Nguyen
cfc998b176 Update Dockerfile.JS.sern 2025-01-28 18:55:05 -06:00
Jacob Nguyen
fca3c76016 fix: Update Dockerfile.TS.sern (#149) 2025-01-28 18:50:44 -06:00
8 changed files with 126 additions and 22 deletions

View File

@@ -2,6 +2,20 @@
All notable changes to this project will be documented in this file. 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) ## [1.3.4](https://github.com/sern-handler/cli/compare/v1.3.3...v1.3.4) (2025-01-22)

4
package-lock.json generated
View File

@@ -1,12 +1,12 @@
{ {
"name": "@sern/cli", "name": "@sern/cli",
"version": "1.3.4", "version": "1.4.0",
"lockfileVersion": 3, "lockfileVersion": 3,
"requires": true, "requires": true,
"packages": { "packages": {
"": { "": {
"name": "@sern/cli", "name": "@sern/cli",
"version": "1.3.4", "version": "1.4.0",
"license": "MIT", "license": "MIT",
"dependencies": { "dependencies": {
"@esbuild-kit/cjs-loader": "^2.4.2", "@esbuild-kit/cjs-loader": "^2.4.2",

View File

@@ -1,6 +1,6 @@
{ {
"name": "@sern/cli", "name": "@sern/cli",
"version": "1.3.4", "version": "1.4.1",
"description": "Official CLI for @sern/handler", "description": "Official CLI for @sern/handler",
"exports": "./dist/index.js", "exports": "./dist/index.js",
"bin": { "bin": {

View File

@@ -7,10 +7,12 @@ import assert from 'node:assert';
import defaultEsbuild from '../utilities/defaultEsbuildConfig'; import defaultEsbuild from '../utilities/defaultEsbuildConfig';
import { require } from '../utilities/require'; import { require } from '../utilities/require';
import { pathExists, pathExistsSync } from 'find-up'; 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 * as Preprocessor from '../utilities/preprocessor';
import { bold, magentaBright } from 'colorette'; import { bold, magentaBright } from 'colorette';
import { parseTsConfig } from '../utilities/parseTsconfig'; import { parseTsConfig } from '../utilities/parseTsconfig';
import { execa, type ExecaChildProcess } from 'execa';
import { InvalidArgumentError } from 'commander';
const VALID_EXTENSIONS = ['.ts', '.js' ]; const VALID_EXTENSIONS = ['.ts', '.js' ];
@@ -49,39 +51,107 @@ type BuildOptions = {
*/ */
sourcemap?: boolean; 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) => { const CommandHandlerPlugin = (buildConfig: Partial<BuildOptions>, ambientFilePath: string, sernTsConfigPath: string) => {
return { return {
name: "commandhandler", name: "commandHandler",
setup(build) { setup(build) {
const options = build.initialOptions const options = build.initialOptions
const defVersion = () => JSON.stringify(require(p.resolve('package.json')).version); const defVersion = () => JSON.stringify(require(p.resolve('package.json')).version);
// should fix a type error
options.define = { options.define = {
...buildConfig.define ?? {}, ...(buildConfig.define ?? {}),
__DEV__: `${buildConfig.mode === 'development'}`, __DEV__: `${buildConfig.mode === 'development'}`,
__PROD__: `${buildConfig.mode === 'production'}`, __PROD__: `${buildConfig.mode === 'production'}`,
__VERSION__: `${buildConfig.defineVersion ? `${defVersion()}` : 'undefined'}` __VERSION__: `${buildConfig.defineVersion ? `${defVersion()}` : 'undefined'}`
} ?? {} }
Preprocessor.writeTsConfig(buildConfig.format!, sernTsConfigPath, writeFile); Preprocessor.writeTsConfig(buildConfig.format!, sernTsConfigPath, writeFile);
Preprocessor.writeAmbientFile(ambientFilePath, options.define!, writeFile); Preprocessor.writeAmbientFile(ambientFilePath, options.define!, writeFile);
} }
} as esbuild.Plugin } as esbuild.Plugin
} }
const resolveBuildConfig = (path: string|undefined, language: string) => { const CommandOnEndPlugin = (watching: boolean, watchCommand?: string) => {
if(language === 'javascript') { // 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 ?? 'jsconfig.json'
} }
return path ?? 'tsconfig.json' return path ?? 'tsconfig.json'
} }
export async function build(options: Record<string, any>) { export async function build(options: Record<string, any>) {
//console.log(options)
if (!options.supressWarnings) { if (!options.supressWarnings) {
console.info(`${magentaBright('EXPERIMENTAL')}: This API has not been stabilized. add -W or --suppress-warnings flag to suppress`); console.info(`${magentaBright('EXPERIMENTAL')}: This API has not been stabilized. add -W or --suppress-warnings flag to suppress`);
} }
console.log(options) // 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(); const sernConfig = await getConfig();
let buildConfig: BuildOptions; let buildConfig: BuildOptions;
const buildConfigPath = p.resolve(options.project ?? 'sern.build.js'); const buildConfigPath = p.resolve(options.project ?? 'sern.build.js');
@@ -94,22 +164,34 @@ export async function build(options: Record<string, any>) {
sourcemap: options.sourceMaps, sourcemap: options.sourceMaps,
tsconfig: resolveBuildConfig(options.tsconfig, sernConfig.language), tsconfig: resolveBuildConfig(options.tsconfig, sernConfig.language),
env: options.env ?? '.env', env: options.env ?? '.env',
include: [] include: [],
watch: {
command: options.watchCommand
}
}; };
// merging configuration with sern.build.js, if exists buildConfigPath
if (pathExistsSync(buildConfigPath)) { if (pathExistsSync(buildConfigPath)) {
//throwable, buildConfigPath may not exist let fileConfig;
buildConfig = { ...defaultBuildConfig, ...(await import('file:///' + buildConfigPath)).default }; 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 { } else {
buildConfig = defaultBuildConfig; buildConfig = defaultBuildConfig;
console.log('No build config found, defaulting'); console.log('No build config found, defaulting');
} }
configDotenv({ path: buildConfig.env }); configDotenv({ path: buildConfig.env });
if (process.env.NODE_ENV) { if (process.env.NODE_ENV) {
buildConfig.mode = process.env.NODE_ENV as 'production' | 'development'; buildConfig.mode = process.env.NODE_ENV as 'production' | 'development';
console.log(magentaBright('NODE_ENV:'), 'Found NODE_ENV variable, setting `mode` to this.'); 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 { try {
let config = await parseTsConfig(buildConfig.tsconfig!); let config = await parseTsConfig(buildConfig.tsconfig!);
config?.extends && console.warn("Extend the generated tsconfig") config?.extends && console.warn("Extend the generated tsconfig")
@@ -130,7 +212,7 @@ export async function build(options: Record<string, any>) {
console.log(' ', magentaBright('sourceMaps'), buildConfig.sourcemap); console.log(' ', magentaBright('sourceMaps'), buildConfig.sourcemap);
const sernDir = p.resolve('.sern'), 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)); ['ambient.d.ts', 'tsconfig.json', 'generated'].map(f => p.resolve(sernDir, f));
if (!(await pathExists(genDir))) { if (!(await pathExists(genDir))) {
@@ -146,14 +228,17 @@ export async function build(options: Record<string, any>) {
//https://esbuild.github.io/content-types/#tsconfig-json //https://esbuild.github.io/content-types/#tsconfig-json
const ctx = await esbuild.context({ const ctx = await esbuild.context({
entryPoints, entryPoints,
plugins: [CommandHandlerPlugin(buildConfig, ambientFilePath, sernTsConfigPath)], plugins: [
CommandHandlerPlugin(buildConfig, ambientFilePath, sernTsConfigPath),
CommandOnEndPlugin(options.watch, buildConfig.watch?.command)
],
sourcemap: buildConfig.sourcemap, sourcemap: buildConfig.sourcemap,
...defaultEsbuild(buildConfig.format!, buildConfig.tsconfig), ...defaultEsbuild(buildConfig.format!, buildConfig.tsconfig),
dropLabels: [buildConfig.mode === 'production' ? '__DEV__' : '__PROD__', ...buildConfig.dropLabels!], dropLabels: [buildConfig.mode === 'production' ? '__DEV__' : '__PROD__', ...buildConfig.dropLabels!],
}); });
await ctx.rebuild() await ctx.rebuild()
if(options.watch) { if (options.watch) {
await ctx.watch() await ctx.watch()
} else { } else {
await ctx.dispose() await ctx.dispose()

View File

@@ -58,6 +58,7 @@ program
.option('-f --format [fmt]', 'The module system of your application. `cjs` or `esm`', 'esm') .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('-m --mode [mode]', 'the mode for sern to build in. `production` or `development`', 'development')
.option('-w --watch') .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('-W --suppress-warnings', 'suppress experimental warning')
.option('-p --project [filePath]', 'build with the provided sern.build file') .option('-p --project [filePath]', 'build with the provided sern.build file')
.option('-e --env', 'path to .env file') .option('-e --env', 'path to .env file')

View File

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

View File

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

View File

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