start watch server

CHANGELOG.md

@@ -2,34 +2,6 @@
 
 All notable changes to this project will be documented in this file.
 
-## [1.2.1](https://github.com/sern-handler/cli/compare/v1.2.0...v1.2.1) (2024-02-08)
-
-
-### Bug Fixes
-
-* better error messages for publish ([d1832e4](https://github.com/sern-handler/cli/commit/d1832e44ce1b10aeb5b9dc902b7d35ab51c41ff3))
-
-## [1.2.0](https://github.com/sern-handler/cli/compare/v1.1.0...v1.2.0) (2024-01-29)
-
-
-### Features
-
-* make application id optional, thanks [@trueharuu](https://github.com/trueharuu) ([#130](https://github.com/sern-handler/cli/issues/130)) ([2d6e65a](https://github.com/sern-handler/cli/commit/2d6e65a1e6073f605aab192b8cea33037a04af2c))
-
-## [1.1.0](https://github.com/sern-handler/cli/compare/v1.0.3...v1.1.0) (2024-01-28)
-
-
-### Features
-
-* command clear ([#128](https://github.com/sern-handler/cli/issues/128)) ([303ac02](https://github.com/sern-handler/cli/commit/303ac0280c7c7c55f2670d49c9685b911670bc05))
-
-## [1.0.3](https://github.com/sern-handler/cli/compare/v1.0.2...v1.0.3) (2023-12-25)
-
-
-### Bug Fixes
-
-* intellisense for esm build ts ([#126](https://github.com/sern-handler/cli/issues/126)) ([a5cb668](https://github.com/sern-handler/cli/commit/a5cb66828eae47d3eac5b86c7e67c01dbed500d5))
-
 ## [1.0.2](https://github.com/sern-handler/cli/compare/v1.0.1...v1.0.2) (2023-11-04)
 
 

package-lock.json

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

package.json

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

src/commands/build.ts

@@ -1,5 +1,5 @@
 import esbuild from 'esbuild';
-import { getConfig } from '../utilities/getConfig';
+import { getConfig, type sernConfig } from '../utilities/getConfig';
 import { resolve } from 'node:path';
 import { glob } from 'glob';
 import { configDotenv } from 'dotenv';
@@ -48,55 +48,63 @@ type BuildOptions = {
     env?: string;
 };
 
-export async function build(options: Record<string, any>) {
-    if (!options.supressWarnings) {
-        console.info(`${magentaBright('EXPERIMENTAL')}: This API has not been stabilized. add -W or --suppress-warnings flag to suppress`);
-    }
-    const sernConfig = await getConfig();
-    let buildConfig: Partial<BuildOptions> = {};
-
-    const entryPoints = await glob(`./src/**/*{${validExtensions.join(',')}}`, {
-        //for some reason, my ignore glob wasn't registering correctly'
-        ignore: {
-            ignored: (p) => p.name.endsWith('.d.ts'),
-        },
-    });
-
-    const buildConfigPath = resolve(options.project ?? 'sern.build.js');
-
-    const resolveBuildConfig = (path: string|undefined, language: string) => {
-       if(language === 'javascript') {
-        return path ?? resolve('jsconfig.json')
-       }
-       return path ?? resolve('tsconfig.json')
-    }
+/*
+ * locates jsconfig or tsconfig depending on language.
+ * If path is not given, default to the current working directory's `(js|ts)config.json`
+ */
+function resolveConfigPath (path: string|undefined, language: string) {
+   if(language === 'javascript') {
+    return path ?? resolve('jsconfig.json')
+   }
+   return path ?? resolve('tsconfig.json')
+}
 
+async function createBuildConfig(options: Record<string,any>, sernConfig: sernConfig) {
+    const buildConfigPath = resolve(options.project ?? 'sern.build.js');    
     const defaultBuildConfig = {
         defineVersion: true,
         format: options.format ?? 'esm',
         mode: options.mode ?? 'development',
         dropLabels: [],
-        tsconfig: resolveBuildConfig(options.tsconfig, sernConfig.language),
+        esbuildPlugins: [],
+        tsconfig: resolveConfigPath(options.tsconfig, sernConfig.language),
         env: options.env ?? resolve('.env'),
-    };
-    if (pathExistsSync(buildConfigPath)) {
-        //throwable, buildConfigPath may not exist
-        buildConfig = {
-            ...defaultBuildConfig,
-            ...(await import('file:///' + buildConfigPath)).default,
-        };
-    } else {
-        buildConfig = defaultBuildConfig;
-        console.log('No build config found, defaulting');
-    }
+    } satisfies BuildOptions;
 
+    if(pathExistsSync(buildConfigPath)) {
+        return {
+             ...defaultBuildConfig,
+            ...(await import('file:///' + buildConfigPath)).default,
+        }
+    } else {
+        return defaultBuildConfig;
+    }
+}
+
+function fillEnv(options: Record<string, any>) {
     let env = {} as Record<string, string>;
-    configDotenv({ path: buildConfig.env, processEnv: env });
-    const modeButNotNodeEnvExists = env.MODE && !env.NODE_ENV;
-    if (modeButNotNodeEnvExists) {
+    configDotenv({ path: options.env, processEnv: env });
+    return env;
+}
+
+export async function build(options: Record<string, any>) {
+    if (!options.supressWarnings) {
+        console.info(`${magentaBright('EXPERIMENTAL')}: This API has not been stabilized. add -W or --suppress-warnings flag to suppress`);
+    }
+    const sernConfig = await getConfig();
+    const entryPoints = await glob(`./src/**/*{${validExtensions.join(',')}}`, {
+        ignore: {
+            ignored: (p) => p.name.endsWith('.d.ts'),
+        },
+    });
+
+    const buildConfig = await createBuildConfig(options, sernConfig);
+    let env = fillEnv(options);
+
+    if (env.MODE && !env.NODE_ENV) {
         console.warn('Use NODE_ENV instead of MODE');
         console.warn('MODE has no effect.');
-        console.warn(`https://nodejs.org/en/learn/getting-started/nodejs-the-difference-between-development-and-production`);
+        console.warn(`https://nodejs.dev/en/learn/nodejs-the-difference-between-development-and-production/`);
     }
 
     if (env.NODE_ENV) {
@@ -104,12 +112,13 @@ export async function build(options: Record<string, any>) {
         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', 'Mode is not `production` or `development`');
 
 
     try {
         let config = require(buildConfig.tsconfig!);
-        config.extends && console.warn("Extend the generated tsconfig")
+        config.extends && console.warn("Please ensure to extend the generated tsconfig")
     } catch(e) {
          console.warn("no tsconfig / jsconfig found");
          console.warn(`Please create a ${sernConfig.language === 'javascript' ? 'jsconfig.json' : 'tsconfig.json' }`);
@@ -129,11 +138,11 @@ export async function build(options: Record<string, any>) {
     console.log(' ', magentaBright('env'), buildConfig.env);
 
     const sernDir = resolve('.sern'),
-          genDir = resolve(sernDir, 'generated'),
-          ambientFilePath = resolve(sernDir, 'ambient.d.ts'),
-          packageJsonPath = resolve('package.json'),
-          sernTsConfigPath = resolve(sernDir, 'tsconfig.json'),
-          packageJson = () => require(packageJsonPath);
+        genDir = resolve(sernDir, 'generated'),
+        ambientFilePath = resolve(sernDir, 'ambient.d.ts'),
+        packageJsonPath = resolve('package.json'),
+        sernTsConfigPath = resolve(sernDir, 'tsconfig.json'),
+        packageJson = () => require(packageJsonPath);
 
     if (!(await pathExists(genDir))) {
         console.log('Making .sern/generated dir, does not exist');

src/commands/command-clear.ts

@@ -1,60 +0,0 @@
-import * as Rest from '../rest.js'
-import assert from 'node:assert'
-import dotenv from 'dotenv'
-import ora from 'ora';
-import type { CommandData, GuildId } from '../utilities/types.js';
-import { readFileSync, writeFile } from 'node:fs'
-import { resolve } from 'node:path'
-import prompts from 'prompts';
-
-const getConfirmation = (args: Record<string,any> ) => {
-    if(args.yes) {
-        return args.yes
-    } else {
-        return prompts({
-            type: 'confirm',
-            name: 'confirmation',
-            message: 'Are you sure you want to delete ALL your application commands?',
-            initial: true
-        }, { onCancel: () => (console.log("Cancelled operation  (￣┰￣*)"), process.exit(1)) })
-        .then(response => response.confirmation);
-    }
-}
-export async function commandClear(args: Record<string,any>) {
-    dotenv.configDotenv({ path: args.env || resolve('.env') })
-    const token = process.env.token || process.env.DISCORD_TOKEN;
-    assert(token, 'Could not find a token for this bot in .env or commandline. Do you have DISCORD_TOKEN in env?');
-    
-    const confirmation = await getConfirmation(args);
-   
-    if (confirmation) {
-        const spin = ora({
-            text: `Deleting ALL application commands...`,
-            spinner: 'aesthetic',
-        }).start();
-        const rest = await Rest.create(token);
-        let guildCommands: Record<GuildId, CommandData[]> 
-        try {
-            guildCommands = JSON.parse(readFileSync('.sern/command-data-remote.json', 'utf-8'))
-            await rest.updateGlobal([]);
-            delete guildCommands.global
-            for (const guildId in guildCommands) {
-                await rest.putGuildCommands(guildId, []);
-            }
-            writeFile('.sern/command-data-remote.json', "{}", (err) => {
-                if(err) {
-                    spin.fail("Error happened while writing to json:");
-                    console.error(err)
-                    process.exit(1)
-                }
-            })
-            spin.succeed();
-        } catch(e) {
-            spin.fail("Something went wrong. ");
-            throw e;
-        }
-    } else {
-        console.log('Operation canceled.  (￣┰￣*)');
-    }
-
-}

src/commands/list.ts

@@ -14,11 +14,9 @@ export function list() {
     const globalCommands = commands.global;
 
     delete commands.global;
-    if(globalCommands) {
-        console.log(bold('Global Commands'));
-        for (const command of globalCommands) log(command);
-    }
-    
+    console.log(bold('Global Commands'));
+    for (const command of globalCommands) log(command);
+
     console.log('\t');
 
     for (const guildId in commands) {

src/commands/publish.ts

@@ -15,7 +15,7 @@ export async function publish(commandDir: string | undefined, args: Partial<Publ
     args.import ??= [];
 
     args.token && console.info('Token passed through command line');
-    args.applicationId && console.info(magentaBright('WARNING')+ ' This option is deprecated. Do not pass applicationId through command line');
+    args.applicationId && console.info('applicationId passed through command line');
     commandDir && console.info('Publishing with override path: ', commandDir);
 
     const dotenvLocation = new URL('../node_modules/dotenv/config.js', rootPath),

src/commands/watch.ts

@@ -0,0 +1,5 @@
+import esbuild from 'esbuild'
+
+export async function watch(argv: unknown) {
+
+}

src/create-publish.mts

@@ -10,8 +10,7 @@ import { once } from 'node:events';
 import * as Rest from './rest';
 import type { sernConfig } from './utilities/getConfig';
 import type { PublishableData, PublishableModule, Typeable } from './create-publish.d.ts';
-import { cyanBright, greenBright, magentaBright, redBright } from 'colorette';
-import { inspect } from 'node:util'
+import { cyanBright, greenBright, redBright } from 'colorette';
 import ora from 'ora';
 
 async function deriveFileInfo(dir: string, file: string) {
@@ -164,7 +163,8 @@ const publishableData = modules.map(makePublishData),
     appid = process.env.applicationId || process.env.APPLICATION_ID;
 
 assert(token, 'Could not find a token for this bot in .env or commandline. Do you have DISCORD_TOKEN in env?');
-appid && console.warn(`${magentaBright('WARNING')}: APPLICATION_ID is not necessary anymore`);
+assert(appid, 'Could not find an application id for this bot in .env or commandline. Do you have APPLICATION_ID in env?');
+
 // partition globally published and guilded commands
 const [globalCommands, guildedCommands] = publishableData.reduce(
     ([globals, guilded], module) => {
@@ -181,7 +181,7 @@ const spin = ora(`Publishing ${cyanBright('Global')} commands`);
 
 globalCommands.length && spin.start();
 
-const rest = await Rest.create(token);
+const rest = Rest.create(appid, token);
 const res = await rest.updateGlobal(globalCommands);
 
 let globalCommandsResponse: unknown;
@@ -192,29 +192,25 @@ if (res.ok) {
     globalCommandsResponse = await res.json();
 } else {
     spin.fail(`Failed to publish global commands [Code: ${redBright(res.status)}]`);
-    let err: Error
-    console.error("Status Text ", res.statusText);
     switch(res.status) {
-        case 400 : {
-            const validation_errors = await res.json()
-            console.error('errors:', inspect(validation_errors, { depth: Infinity }));
-            console.error("Modules with validation errors:" 
-                          + inspect(Object.keys(validation_errors.errors).map(idx => globalCommands[idx as any])))
+        case 400 : 
             throw Error("400: Ensure your commands have proper fields and data with nothing left out");
-        }
-        case 404 : {
-            console.error('errors:', inspect(await res.json(), { depth: Infinity }));
+        case 404 : 
             throw Error("Forbidden 404. Is you application id and/or token correct?")
-        } 
-        case 429: {
-            console.error('errors:', inspect(await res.json(), { depth: Infinity }));
-            err = Error('Chill out homie, too many requests') 
-        } break;
-        default: {
-            console.error('errors:', inspect(await res.json(), { depth: Infinity }));
-            throw Error(res.status.toString() + " error")
-        }
+        case 429: 
+            throw Error('Chill out homie, too many requests')
     }
+    console.error('errors:',
+        await res
+            .json()
+            .then((res) => {
+                const errors = Object.values(res?.errors ?? {});
+                // @ts-ignore
+                return errors.map((err) => err?.name?._errors);
+            })
+            .catch(() => "No errors found (Unparsable json for a request with bad status code). Read the status code.")
+    );
+    console.error("Status Text ", res.statusText);
 }
 
 function associateGuildIdsWithData(data: PublishableModule[]): Map<string, PublishableData[]> {
@@ -253,21 +249,12 @@ for (const [guildId, array] of guildCommandMap.entries()) {
     } else {
         spin.fail(`[${redBright(guildId)}] Failed to update commands for guild, Reason: ${result.message}`);
         switch(response.status) {
-            case 400 : {
-                console.error(inspect(result, { depth: Infinity }))
-                console.error("Modules with validation errors:" 
-                + inspect(Object.keys(result.errors).map(idx => array[idx as any])))
-
+            case 400 : 
                 throw Error("400: Ensure your commands have proper fields and data and nothing left out");
-            }
-            case 404 : {
-                console.error(inspect(result, { depth: Infinity }))
+            case 404 : 
                 throw Error("Forbidden 404. Is you application id and/or token correct?")
-            }
-            case 429: {
-                console.error(inspect(result, { depth: Infinity }))
+            case 429: 
                 throw Error('Chill out homie, too many requests')
-            }
         }
     }
 }

src/index.ts

@@ -43,16 +43,12 @@ program //
             .option('--appId [applicationId]')
             .argument('[path]', 'path with respect to current working directory that will locate all published files')
             .action(async (...args) => importDynamic('publish.js').then((m) => m.publish(...args)))
-    ).addCommand(
+    )
+    .addCommand(
         new Command('list') //
             .description('List all slash commands')
-            .action(async (...args) => importDynamic('list.js').then((m) => m.list(...args))))
-    .addCommand(
-        new Command('clear')
-            .description('Clear and reset commands-data-remote.json and the api')
-            .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))));
+            .action(async (...args) => importDynamic('list.js').then((m) => m.list(...args)))
+    );
 
 program
     .command('build')
@@ -64,5 +60,8 @@ program
     .option('-e --env', 'path to .env file')
     .option('--tsconfig [filePath]', 'Use this tsconfig')
     .action(async (...args) => importDynamic('build.js').then((m) => m.build(...args)));
-
+program
+    .command('watch')
+    .description('start a hmr session')
+    .action(async (...args) => importDynamic('watch.js').then((m) => m.watch(...args)))
 program.parse();

src/rest.ts

@@ -11,22 +11,12 @@ const publishablesIntoJson = (ps: PublishableModule[]) =>
         4
     );
 
-export const create = async (token: string) => {
+export const create = (appid: string, token: string) => {
+    const globalURL = new URL(`${appid}/commands`, baseURL);
     const headers = {
         Authorization: 'Bot ' + token,
         'Content-Type': 'application/json',
     };
-    let me;
-    let appid: string;
-    try {
-        me = await fetch(new URL('@me', baseURL), { headers }).then(res => res.json());
-        appid = me.id;
-    } catch(e) {
-        console.log("Something went wrong while trying to fetch your application:");
-        throw e;
-    }
-    const globalURL = new URL(`${appid}/commands`, baseURL);
-    
     return {
         updateGlobal: (commands: PublishableModule[]) =>
             fetch(globalURL, {

src/types/config.d.ts

@@ -13,7 +13,7 @@ export interface sernConfig {
 
 export interface TheoreticalEnv {
     DISCORD_TOKEN: string;
-    APPLICATION_ID?: string;
+    APPLICATION_ID: string;
     MODE: 'PROD' | 'DEV';
     [name: string]: string;
 }

src/utilities/preprocessor.ts

@@ -6,9 +6,9 @@ const processEnvType = (env: NodeJS.ProcessEnv) => {
     const envBuilder = new StringWriter();
 
     for (const key of entries) {
-        envBuilder.tab()
-                  .tab()
-                  .envField(key);
+        envBuilder.tab();
+        envBuilder.tab();
+        envBuilder.envField(key);
     }
     return envBuilder.build();
 };
@@ -40,8 +40,6 @@ const writeTsConfig = async (format: 'cjs' | 'esm', configPath: string, fw: File
     const target = format === 'esm' ? { target: 'esnext' } : {};
     const sernTsConfig = {
         compilerOptions: {
-            //module determines top level await. CJS doesn't have that abliity afaik
-            module: format === 'cjs' ? 'node' : 'esnext',
             moduleResolution: 'node',
             strict: true,
             skipLibCheck: true,
@@ -71,7 +69,6 @@ class StringWriter {
         return this;
     }
     envField(key: string) {
-        //if env field has space or parens, wrap key in ""
         if (/\s|\(|\)/g.test(key)) {
             this.fileString += `"${key}": string`;
         } else {