auklet 0.0.3 → 0.0.4

package/README.md

@@ -1,4 +1,11 @@
-# auklet
+<div align="center">
+<h2>auklet</h2>
+
+[![NPM version](https://img.shields.io/npm/v/auklet.svg?style=flat-square)](https://www.npmjs.com/package/auklet)
+
+</div>
+
+<h1></h1>
 
 Build utilities for TypeScript packages and module CSS output.
 
@@ -45,59 +52,91 @@ Create `auklet.config.ts` in the package root:
 import type { AukletConfig } from 'auklet';
 
 export const config: AukletConfig = {
-  sourceDir: 'src',
-  outputDir: 'dist',
-  themes: {
-    light: './src/themes/light.css',
-    dark: './src/themes/dark.css',
-  },
-  cssDependencies: {
-    '@scope/ui': {
-      global: '/style.css',
-      component: ['/components/**.css'],
+  source: 'src',
+  output: 'dist',
+  styles: {
+    themes: {
+      light: './src/themes/light.css',
+      dark: './src/themes/dark.css',
     },
-    '@scope/theme': {
-      global: '/style.css',
-      themes: {
-        light: '/themes/light.css',
-        dark: '/themes/dark.css',
+    dependencies: {
+      '@scope/ui': {
+        entry: '/style.css',
+        components: ['/components/**.css'],
+      },
+      '@scope/theme': {
+        entry: '/style.css',
+        themes: {
+          light: '/themes/light.css',
+          dark: '/themes/dark.css',
+        },
       },
     },
   },
+  modules: true,
   build: {
     formats: ['esm', 'cjs'],
-    modules: true,
+    target: 'es2020',
     tsconfig: 'tsconfig.json',
   },
 };
 ```
 
-### CSS Options
+### Style Options
 
-- `sourceDir`: source directory relative to the package root. Defaults to `src`.
-- `outputDir`: build output directory relative to the package root. Defaults to `dist`.
-- `themes`: package theme style entries. Defaults to no themes.
-- `cssDependencies`: external package style dependencies.
+- `source`: source directory relative to the package root. Defaults to `src`.
+- `output`: build output directory relative to the package root. Defaults to `dist`.
+- `styles.themes`: package theme style entries. Defaults to `{}`.
+- `styles.dependencies`: external package style dependencies. Defaults to `{}`.
 
-Each `cssDependencies` entry may define:
+Each `styles.dependencies` entry may define:
 
-- `global`: package-level style dependency.
+- `entry`: package-level style dependency.
 - `themes`: theme style dependency map.
-- `component`: glob-like component style rules used to infer style imports from source imports.
+- `components`: glob-like component style rules used to infer style imports from source imports.
+
+Style configuration should use the grouped `styles` field.
+
+```ts
+export const config: AukletConfig = {
+  styles: {
+    dependencies: {
+      '@scope/ui': {
+        entry: '/style.css',
+        components: ['/components/**.css'],
+      },
+    },
+  },
+};
+```
 
 ### Build Options
 
-- `formats`: package bundle formats: `esm`, `cjs`, or `iife`.
-- `banner`: custom bundle banner.
-- `externals`: additional external packages.
-- `modules`: whether to generate unbundled `dist/es` and `dist/lib` output.
-- `tsconfig`: TypeScript config path relative to the package root.
+- `modules`: whether to generate unbundled `dist/es` and `dist/lib` output. Defaults to `false`. CSS module style entries also follow this flag.
+- `build.formats`: package bundle formats: `esm`, `cjs`, or `iife`. Defaults to `['cjs', 'esm', 'iife']`.
+- `build.target`: JavaScript compilation target passed to tsdown. Defaults to `es2020` and is shared by bundle, global, and module output.
+- `build.platform`: build target runtime platform: `neutral`, `node`, or `browser`. Defaults to `neutral`.
+- `build.banner`: custom bundle banner. Defaults to a package name/version banner.
+- `build.externals`: additional external packages. Defaults to `[]`.
+- `build.tsconfig`: TypeScript config path relative to the package root. Defaults to the nearest `tsconfig.json` found from the package root upward.
+
+### Build Constants
+
+`auk build` injects these compile-time constants into bundled output:
+
+- `__DEV__`: `true` when `process.env.NODE_ENV !== 'production'`, otherwise `false`.
+- `__TEST__`: always `false` in package builds.
+- `__VERSION__`: current package version from `package.json`.
+
+Vitest uses the same names with test-friendly values: `__DEV__` is `true`, `__TEST__` is `true`, and `__VERSION__` is `'unknown'`.
 
 ## CSS Output
 
-`build-css` generates package and module style entries under the output directory.
+`build-css` always generates the package-level `index.css` when source styles exist.
+
+Module style entries under `dist/es` and `dist/lib` are generated only when `modules` is `true`, matching the JavaScript module output.
 
-Typical output includes:
+Typical module output includes:
 
 ```text
 dist/
@@ -129,13 +168,13 @@ Important entry semantics:
 
 ## Vite Plugin
 
-Use `aukletCssPlugin` in Vite dev mode to load virtual package CSS entries.
+Use `aukletStylePlugin` in Vite dev mode to load virtual package CSS entries.
 
 ```ts
-import { aukletCssPlugin } from 'auklet';
+import { aukletStylePlugin } from 'auklet';
 
 export default {
-  plugins: [aukletCssPlugin()],
+  plugins: [aukletStylePlugin()],
 };
 ```
 
@@ -151,16 +190,16 @@ import '@scope/app/themes/light.css';
 
 ```ts
 import {
-  ModuleCssBuilder,
-  ModuleCssWatcher,
-  aukletCssPlugin,
+  ModuleStyleBuilder,
+  ModuleStyleWatcher,
+  aukletStylePlugin,
   loadAukletConfig,
   runTsdown,
 } from 'auklet';
 
 const aukletConfig = await loadAukletConfig(process.cwd());
 
-await new ModuleCssBuilder({
+await new ModuleStyleBuilder({
   packageRoot: process.cwd(),
   aukletConfig,
 }).build();
@@ -168,9 +207,9 @@ await new ModuleCssBuilder({
 
 Public exports include:
 
-- `ModuleCssBuilder`
-- `ModuleCssWatcher`
-- `aukletCssPlugin`
+- `ModuleStyleBuilder`
+- `ModuleStyleWatcher`
+- `aukletStylePlugin`
 - `loadAukletConfig`
 - `resolveAukletConfigModule`
 - `createTsdownArgs`

package/bin/entry.cjs

@@ -4,7 +4,19 @@ const fs = require('node:fs');
 const path = require('node:path');
 const minimist = require('minimist');
 
-const runBuildCss = async (args) => {
+const getPackageVersion = () => {
+  const packageJson = JSON.parse(
+    fs.readFileSync(path.resolve(__dirname, '../package.json'), 'utf8'),
+  );
+  return packageJson.version;
+};
+
+const runVersion = async () => {
+  console.log(getPackageVersion());
+  return 0;
+};
+
+const runBuildStyle = async (args) => {
   const shouldWatch = args.includes('--watch') || args.includes('-w');
   const { loadAukletConfig } = await import('../dist/configLoader.js');
   const aukletConfig = await loadAukletConfig(process.cwd(), {
@@ -12,10 +24,8 @@ const runBuildCss = async (args) => {
   });
 
   if (shouldWatch) {
-    const { ModuleCssWatcher } = await import(
-      '../dist/css/watch/moduleCssWatcher.js'
-    );
-    const watcher = new ModuleCssWatcher({ aukletConfig, logger: console });
+    const { ModuleStyleWatcher } = await import('../dist/css/watch/watcher.js');
+    const watcher = new ModuleStyleWatcher({ aukletConfig, logger: console });
     await watcher.watch();
     const close = () => {
       watcher
@@ -29,10 +39,10 @@ const runBuildCss = async (args) => {
     return 0;
   }
 
-  const { ModuleCssBuilder } = await import(
-    '../dist/css/production/moduleCssBuilder.js'
+  const { ModuleStyleBuilder } = await import(
+    '../dist/css/production/builder.js'
   );
-  const builder = new ModuleCssBuilder({ aukletConfig, logger: console });
+  const builder = new ModuleStyleBuilder({ aukletConfig, logger: console });
   await builder.build();
   return 0;
 };
@@ -51,7 +61,7 @@ const runBuild = async (args) => {
   const jsExitCode = await runBuildJs(args);
   if (jsExitCode) return jsExitCode;
 
-  return runBuildCss([]);
+  return runBuildStyle([]);
 };
 
 const runDev = async () => {
@@ -90,9 +100,10 @@ const runDev = async () => {
 };
 
 const argv = minimist(process.argv.slice(2), {
-  boolean: ['help'],
+  boolean: ['help', 'version'],
   alias: {
     h: 'help',
+    v: 'version',
   },
 });
 const [command, ...args] = argv._;
@@ -100,6 +111,11 @@ const commandIndex = process.argv.indexOf(command);
 const commandArgs =
   commandIndex >= 0 ? process.argv.slice(commandIndex + 1) : args;
 
+if (argv.version) {
+  console.log(getPackageVersion());
+  process.exit(0);
+}
+
 if (argv.help || !command) {
   console.log('Usage: auk <command>');
   console.log('');
@@ -108,14 +124,20 @@ if (argv.help || !command) {
   console.log('  build-js  Build package JavaScript output with tsdown');
   console.log('  build-css  Build package module CSS output, supports --watch');
   console.log('  dev       Watch package JavaScript and CSS output');
+  console.log('  version   Print auklet version');
+  console.log('');
+  console.log('Options:');
+  console.log('  -v, --version  Print auklet version');
+  console.log('  -h, --help     Print help');
   process.exit(argv.help ? 0 : 1);
 }
 
 const runners = {
   build: runBuild,
   'build-js': runBuildJs,
-  'build-css': runBuildCss,
+  'build-css': runBuildStyle,
   dev: runDev,
+  version: runVersion,
 };
 
 const runner = runners[command];

package/dist/build/runTsdown.js

@@ -25,12 +25,11 @@ export function createTsdownArgs(args) {
   return [tsdownRunFile, ...tsdownArgs];
 }
 export async function runTsdown(args, options = {}) {
-  var _a, _b;
   const tsdownArgs = createTsdownArgs(args);
   const result = await execa(process.execPath, tsdownArgs, {
-    cwd: (_a = options.cwd) !== null && _a !== void 0 ? _a : process.cwd(),
+    cwd: options.cwd ?? process.cwd(),
     stdio: 'inherit',
     reject: false,
   });
-  return (_b = result.exitCode) !== null && _b !== void 0 ? _b : 0;
+  return result.exitCode ?? 0;
 }

package/dist/build/tsdownConfig.d.ts

@@ -4,9 +4,145 @@ export type TsdownFormat = PackageBuildFormat;
 export declare function defineKernelPackageConfigFromOptions(
   packageRoot?: string,
   config?: AukletConfig,
-): Array<UserConfig>;
+): (
+  | {
+      entry: {
+        index: string;
+      };
+      format: PackageBuildFormat;
+      globalName: string;
+      outDir: string;
+      dts: boolean;
+      treeshake: true;
+      banner: string;
+      outExtensions: () => {
+        js: string;
+      };
+      outputOptions: {
+        entryFileNames: string;
+        chunkFileNames: string;
+        globals: {
+          [k: string]: string;
+        };
+      };
+      cwd: string;
+      root: string;
+      clean: false;
+      sourcemap: false;
+      tsconfig: string;
+      target: NonNullable<
+        import('#auklet/types').PackageBuildTarget | undefined
+      >;
+      platform: NonNullable<
+        import('#auklet/types').PackageBuildPlatform | undefined
+      >;
+      deps: import('node_modules/tsdown/dist/types-CQaSBA5U.mjs').L;
+      define: {
+        __TEST__: string;
+        __VERSION__: string;
+        __DEV__: string;
+      };
+    }
+  | {
+      entry: Record<string, string>;
+      format: 'cjs' | 'esm';
+      outDir: string;
+      dts: true;
+      unbundle: true;
+      outExtensions: () => {
+        js: string;
+        dts: string;
+      };
+      cwd: string;
+      root: string;
+      clean: false;
+      sourcemap: false;
+      tsconfig: string;
+      target: NonNullable<
+        import('#auklet/types').PackageBuildTarget | undefined
+      >;
+      platform: NonNullable<
+        import('#auklet/types').PackageBuildPlatform | undefined
+      >;
+      deps: import('node_modules/tsdown/dist/types-CQaSBA5U.mjs').L;
+      define: {
+        __TEST__: string;
+        __VERSION__: string;
+        __DEV__: string;
+      };
+    }
+)[];
 export declare function defineKernelPackageConfigFromFile(
   packageRoot?: string,
-): Promise<Array<UserConfig>>;
+): Promise<
+  (
+    | {
+        entry: {
+          index: string;
+        };
+        format: PackageBuildFormat;
+        globalName: string;
+        outDir: string;
+        dts: boolean;
+        treeshake: true;
+        banner: string;
+        outExtensions: () => {
+          js: string;
+        };
+        outputOptions: {
+          entryFileNames: string;
+          chunkFileNames: string;
+          globals: {
+            [k: string]: string;
+          };
+        };
+        cwd: string;
+        root: string;
+        clean: false;
+        sourcemap: false;
+        tsconfig: string;
+        target: NonNullable<
+          import('#auklet/types').PackageBuildTarget | undefined
+        >;
+        platform: NonNullable<
+          import('#auklet/types').PackageBuildPlatform | undefined
+        >;
+        deps: import('node_modules/tsdown/dist/types-CQaSBA5U.mjs').L;
+        define: {
+          __TEST__: string;
+          __VERSION__: string;
+          __DEV__: string;
+        };
+      }
+    | {
+        entry: Record<string, string>;
+        format: 'cjs' | 'esm';
+        outDir: string;
+        dts: true;
+        unbundle: true;
+        outExtensions: () => {
+          js: string;
+          dts: string;
+        };
+        cwd: string;
+        root: string;
+        clean: false;
+        sourcemap: false;
+        tsconfig: string;
+        target: NonNullable<
+          import('#auklet/types').PackageBuildTarget | undefined
+        >;
+        platform: NonNullable<
+          import('#auklet/types').PackageBuildPlatform | undefined
+        >;
+        deps: import('node_modules/tsdown/dist/types-CQaSBA5U.mjs').L;
+        define: {
+          __TEST__: string;
+          __VERSION__: string;
+          __DEV__: string;
+        };
+      }
+  )[]
+>;
 declare const _default: Promise<UserConfig[]>;
 export default _default;