chokibasic 1.2.3 → 2.0.1

package/index.d.ts

@@ -1,137 +1,190 @@
-declare namespace chokibasic {
-  // --- NOUVEAUX TYPES POUR buildConf ---
-
-  /** 
-   * Callback pour buildConf. 
-   * Reçoit le contenu brut (Buffer) et le chemin relatif du fichier.
-   * Doit retourner la nouvelle valeur (string, objet, etc.) qui remplacera le chemin dans le JSON final.
-   */
-  export type BuildConfCallback = (content: Buffer, relPath: string) => any | Promise<any>;
-
-  /** 
-   * Dictionnaire de patterns globaux associés à des callbacks de transformation.
-   * Exemple: { "** / *.mid": (buf) => processMidi(buf) }
-   */
-  export interface BuildConfMatchers {
-    [glob: string]: BuildConfCallback;
-  }
-
-  // --- TYPES EXISTANTS ---
-
-  export type GlobPattern = string;
-
-  export type IgnoreMatcher =
-    | string
-    | RegExp
-    | ((relPosixPath: string) => boolean);
-
-  export type WatchEventType = "add" | "change" | "unlink" | (string & {});
-
-  export interface WatchEvent {
-    type: WatchEventType;
-    file: string;
-  }
-
-  export interface WatchRuleContext {
-    rule: WatchRule;
-  }
-
-  export interface WatchRule {
-    name?: string;
-    patterns: GlobPattern | GlobPattern[];
-    ignored?: IgnoreMatcher[];
-    debounceMs?: number;
-    callback: (events: WatchEvent[], ctx: WatchRuleContext) => void | Promise<void>;
-  }
-
-  export interface AwaitWriteFinishOptions {
-    stabilityThreshold?: number;
-    pollInterval?: number;
-  }
-
-  export interface CreateWatchersOptions {
-    cwd?: string;
-    globalIgnored?: string[];
-    ignoreInitial?: boolean;
-    awaitWriteFinish?: boolean | AwaitWriteFinishOptions;
-    usePolling?: boolean;
-    interval?: number;
-    binaryInterval?: number;
-    debug?: boolean;
-    [key: string]: unknown;
-  }
-
-  export interface WatchersController {
-    close: () => Promise<void>;
-  }
-
-  export interface ExportDistStats {
-    copied: number;
-    skipped: number;
-  }
-
-  export interface ExportDistOptions {
-    ignore?: string[];
-    include?: string[];
-    debug?: boolean;
-    filter?: (relPath: string) => boolean;
-  }
-
-  export type BuildJSOptions = Parameters<typeof import("esbuild").build>[0];
-  export type BuildCSSOptions = NonNullable<Parameters<typeof import("sass").compile>[1]>;
-
-  // --- FONCTIONS EXPORTÉES ---
-
-  /**
-   * Transforme un fichier YAML en JSON en appliquant des transformations sur les fichiers référencés.
-   * @param src Chemin vers le fichier source YAML.
-   * @param dst Chemin vers le fichier de destination JSON.
-   * @param matchers Dictionnaire de patterns et callbacks de transformation.
-   */
-  export function buildConf(
-    src: string,
-    dst: string,
-    matchers?: BuildConfMatchers
-  ): Promise<void>;
-
-  export function createWatchers(
-    rules: WatchRule[],
-    options?: CreateWatchersOptions
-  ): WatchersController;
-
-  export function exportDist(
-    src: string,
-    dist: string,
-    banner?: string | null,
-    options?: ExportDistOptions
-  ): Promise<ExportDistStats>;
-
-  export function buildCSS(
-    inputScss: string,
-    outCssMin: string,
-    options?: BuildCSSOptions
-  ): Promise<void>;
-
-  export function buildJS(
-    entry: string,
-    outfile: string,
-    options?: BuildJSOptions
-  ): Promise<void>;
-
-  export function buildPHP(file: string): Promise<void>;
-
-  export function buildSitemap(file: string): Promise<void>;
+import type { BuildOptions } from "esbuild";
+import type { Options as SassOptions } from "sass";
+
+// ─── buildConf ────────────────────────────────────────────────────────────────
+
+/**
+ * Callback pour buildConf.
+ * Reçoit le contenu brut (Buffer) et le chemin relatif du fichier.
+ * Doit retourner la nouvelle valeur (string, objet, etc.) qui remplacera
+ * le chemin dans le JSON final.
+ */
+export type BuildConfCallback = (content: Buffer, relPath: string) => any | Promise<any>;
+
+/**
+ * Dictionnaire de patterns globaux associés à des callbacks de transformation.
+ * Exemple : { "**\/*.mid": (buf) => processMidi(buf) }
+ */
+export interface BuildConfMatchers {
+  [glob: string]: BuildConfCallback;
 }
 
-declare const chokibasic: {
-  buildConf: typeof chokibasic.buildConf; // Ajouté ici aussi
-  createWatchers: typeof chokibasic.createWatchers;
-  exportDist: typeof chokibasic.exportDist;
-  buildCSS: typeof chokibasic.buildCSS;
-  buildJS: typeof chokibasic.buildJS;
-  buildPHP: typeof chokibasic.buildPHP;
-  buildSitemap: typeof chokibasic.buildSitemap;
-};
-
-export = chokibasic;
-export as namespace chokibasic;
+/**
+ * Transforme un fichier YAML en JSON en appliquant des transformations
+ * sur les fichiers référencés dans les valeurs.
+ * Les tokens __VERSION__ et __DATE__ sont remplacés automatiquement.
+ *
+ * @param src     Chemin vers le fichier source YAML.
+ * @param dst     Chemin vers le fichier de destination JSON.
+ * @param matchers Dictionnaire de patterns et callbacks de transformation.
+ */
+export function buildConf(
+  src: string,
+  dst: string,
+  matchers?: BuildConfMatchers
+): Promise<void>;
+
+// ─── buildCSS ─────────────────────────────────────────────────────────────────
+
+export type BuildCSSOptions = SassOptions<"sync">;
+
+/**
+ * Compile un fichier SCSS en CSS minifié via Sass + csso.
+ * Si `options.style === "expanded"`, csso est ignoré et le CSS est écrit tel quel.
+ *
+ * @param inputScss  Chemin vers le fichier SCSS source.
+ * @param outCssMin  Chemin vers le fichier CSS de sortie.
+ * @param options    Options Sass (style, loadPaths, sourceMap, …).
+ */
+export function buildCSS(
+  inputScss: string,
+  outCssMin: string,
+  options?: BuildCSSOptions
+): Promise<void>;
+
+// ─── buildJS ──────────────────────────────────────────────────────────────────
+
+export type BuildJSOptions = BuildOptions;
+
+/**
+ * Bundle et minifie un fichier JavaScript via esbuild.
+ *
+ * @param entry    Chemin vers le fichier d'entrée.
+ * @param outfile  Chemin vers le fichier de sortie.
+ * @param options  Options esbuild (target, format, loader, plugins, …).
+ */
+export function buildJS(
+  entry: string,
+  outfile: string,
+  options?: BuildJSOptions
+): Promise<void>;
+
+// ─── buildPHP / buildSitemap ──────────────────────────────────────────────────
+
+/**
+ * Génère du HTML à partir d'un fichier PHP via pxpros.
+ *
+ * @param file Chemin vers le fichier PHP source.
+ */
+export function buildPHP(file: string): Promise<void>;
+
+/**
+ * Génère un sitemap XML via pxpros.
+ *
+ * @param file Chemin vers le fichier de configuration du sitemap.
+ */
+export function buildSitemap(file: string): Promise<void>;
+
+// ─── exportDist ───────────────────────────────────────────────────────────────
+
+export interface ExportDistOptions {
+  /** Patterns glob supplémentaires à ignorer (en plus du .gitignore et de dist/). */
+  ignore?: string[];
+}
+
+export interface ExportDistStats {
+  copied: number;
+  skipped: number;
+}
+
+/**
+ * Copie les fichiers de `src` vers `dist` en respectant le .gitignore,
+ * en excluant les fichiers SCSS, JS non-minifiés et les fichiers/dossiers
+ * préfixés par `_`.
+ * Injecte automatiquement un banner dans les fichiers .js, .css et .html,
+ * et remplace les tokens ###YEAR###, ###TIMESTAMP### et ###TODAY###.
+ *
+ * @param src     Dossier source.
+ * @param dist    Dossier de destination (vidé avant la copie).
+ * @param banner  Chemin vers un fichier texte de banner personnalisé (optionnel).
+ * @param options Options supplémentaires.
+ */
+export function exportDist(
+  src: string,
+  dist: string,
+  banner?: string | null,
+  options?: ExportDistOptions
+): Promise<ExportDistStats>;
+
+// ─── createWatchers ───────────────────────────────────────────────────────────
+
+export type GlobPattern = string;
+
+export type IgnoreMatcher =
+  | string
+  | RegExp
+  | ((relPosixPath: string) => boolean);
+
+export type WatchEventType = "add" | "change" | "unlink" | (string & {});
+
+export interface WatchEvent {
+  type: WatchEventType;
+  /** Chemin relatif au cwd, en format posix. */
+  file: string;
+}
+
+export interface WatchRuleContext {
+  rule: WatchRule;
+}
+
+export interface WatchRule {
+  /** Nom de la règle (utilisé dans les logs). */
+  name?: string;
+  /** Un ou plusieurs patterns glob à surveiller. */
+  patterns: GlobPattern | GlobPattern[];
+  /** Patterns/regex/fonctions à ignorer pour cette règle. */
+  ignored?: IgnoreMatcher[];
+  /** Délai de debounce en ms avant de déclencher le callback (défaut : 150). */
+  debounceMs?: number;
+  /** Appelé avec le batch d'événements déclencheurs. */
+  callback: (events: WatchEvent[], ctx: WatchRuleContext) => void | Promise<void>;
+}
+
+export interface AwaitWriteFinishOptions {
+  stabilityThreshold?: number;
+  pollInterval?: number;
+}
+
+export interface CreateWatchersOptions {
+  /** Répertoire de travail (défaut : process.cwd()). */
+  cwd?: string;
+  /** Patterns ignorés globalement, appliqués à toutes les règles (défaut : node_modules, .git, dist). */
+  globalIgnored?: string[];
+  /** Ignorer les événements au démarrage du watcher (défaut : true). */
+  ignoreInitial?: boolean;
+  awaitWriteFinish?: boolean | AwaitWriteFinishOptions;
+  /** Activer le polling (utile sous WSL, OneDrive, montages réseau). */
+  usePolling?: boolean;
+  interval?: number;
+  binaryInterval?: number;
+  /** Activer les logs de debug (défaut : true). */
+  debug?: boolean;
+  [key: string]: unknown;
+}
+
+export interface WatchersController {
+  /** Arrête proprement tous les watchers et vide les queues. */
+  close: () => Promise<void>;
+}
+
+/**
+ * Crée un ou plusieurs watchers chokidar avec filtrage par patterns glob,
+ * debounce, et exécution sérialisée des callbacks.
+ *
+ * @param rules   Liste des règles de surveillance.
+ * @param options Options globales des watchers.
+ */
+export function createWatchers(
+  rules: WatchRule[],
+  options?: CreateWatchersOptions
+): WatchersController;

package/index.js

@@ -1,8 +1,6 @@
-module.exports = {
-	...require("./src/buildjs.js"),
-	...require("./src/buildcss.js"),
-	...require("./src/buildphp.js"),
-	...require("./src/buildconf.js"),
-	...require("./src/export.js"),
-	...require("./src/watchers.js"),
-};
+export { buildJS } from "./src/buildjs.js";
+export { buildCSS } from "./src/buildcss.js";
+export { buildPHP, buildSitemap } from "./src/buildphp.js";
+export { buildConf } from "./src/buildconf.js";
+export { exportDist } from "./src/export.js";
+export { createWatchers } from "./src/watchers.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chokibasic",
-  "version": "1.2.3",
+  "version": "2.0.1",
   "description": "Basic chokidar watcher + pxpros + esbuild + sass + csso helpers",
   "main": "index.js",
   "types": "index.d.ts",
@@ -25,7 +25,7 @@
   ],
   "author": "Maxime Larrivée-Roy",
   "license": "MIT",
-  "type": "commonjs",
+  "type": "module",
   "bugs": {
     "url": "https://github.com/ZmotriN/chokibasic/issues"
   },
@@ -35,9 +35,13 @@
     "csso": "^5.0.5",
     "esbuild": "^0.28.0",
     "ignore": "^7.0.5",
-    "js-yaml": "^4.1.1",
+    "js-yaml": "^4.2.0",
     "picomatch": "^4.0.4",
-    "pxpros": "^1.1.3",
+    "pxpros": "^2.0.1",
     "sass": "^1.100.0"
+  },
+  "allowScripts": {
+    "@parcel/watcher@2.5.6": true,
+    "esbuild@0.28.0": true
   }
 }

package/readme.md

@@ -235,6 +235,12 @@ await exportDist("src", "dist", "src/banner.txt");
 
 ## Changelog
 
+## Version 2.0.1
+* PXPros v2.0.1 with YAML for PHP
+
+## Version 2.0.0
+* PXPros v2.0.0 with PHP-WASM included
+
 ### Version 1.1.8
 * Update dependancy: pxpros 1.1.3
 

package/src/buildconf.js

@@ -1,7 +1,7 @@
-const fs = require('fs/promises');
-const path = require("path");
-const yaml = require("js-yaml");
-const pm = require("picomatch");
+import fs from 'fs/promises';
+import path from "path";
+import yaml from "js-yaml";
+import pm from "picomatch";
 
 const ROOT = process.cwd();
 
@@ -71,4 +71,4 @@ async function buildConf(src, dst, matchers = {}) {
     }
 }
 
-module.exports = { buildConf };
+export { buildConf };

package/src/buildcss.js

@@ -1,7 +1,7 @@
-const sass = require("sass");
-const csso = require("csso");
-const path = require("path");
-const fs = require("node:fs");
+import * as sass from 'sass'
+import { minify } from 'csso';
+import path from "path";
+import fs from "node:fs";
 
 const buildCSS = async (inputScss, outCssMin, options = {}) => {
 	// let compiled;
@@ -16,7 +16,7 @@ const buildCSS = async (inputScss, outCssMin, options = {}) => {
 		if(options?.style == "expanded"){
 			fs.writeFileSync(outCssMin, compiled.css);
 		} else {
-			const minified = csso.minify(compiled.css, { restructure: false });
+			const minified = minify(compiled.css, { restructure: false });
 			fs.writeFileSync(outCssMin, minified.css);
 		}
 		console.log(`✅ CSS generated: ${outCssMin}`);
@@ -26,4 +26,4 @@ const buildCSS = async (inputScss, outCssMin, options = {}) => {
 	}
 }
 
-module.exports = { buildCSS };
+export { buildCSS };

package/src/buildjs.js

@@ -1,4 +1,5 @@
-const esbuild = require("esbuild");
+// const esbuild = require("esbuild");
+import esbuild from "esbuild";
 
 
 const buildJS = async (entry, outfile, options = {}) => {
@@ -33,4 +34,4 @@ const buildJS = async (entry, outfile, options = {}) => {
 	}
 }
 
-module.exports = { buildJS };
+export { buildJS };

package/src/buildphp.js

@@ -1,8 +1,8 @@
-const pxpros = require("pxpros");
+import { sitemap, render } from "pxpros";
 
 
 const buildPHP = async (file) => {
-	const results = await pxpros.render(file);
+	const results = await render(file);
 	if(results.success) {
 		results.files.forEach(file => console.log(`✅ HTML generated: ${file}`));
 	} else {
@@ -13,7 +13,7 @@ const buildPHP = async (file) => {
 
 
 const buildSitemap = async (file) => {
-	const results = await pxpros.sitemap(file);
+	const results = await sitemap(file);
 	if(results.success) {
 		results.files.forEach(file => console.log(`✅ XML Sitemap generated: ${file}`));
 	} else {
@@ -22,4 +22,4 @@ const buildSitemap = async (file) => {
 	}
 }
 
-module.exports = { buildPHP, buildSitemap };
+export { buildPHP, buildSitemap };

package/src/export.js

@@ -1,10 +1,15 @@
-const fsprom = require('fs/promises');
-const ignore = require('ignore');
-const fs = require("node:fs");
-const path = require("path");
+import fsprom from 'fs/promises';
+import ignore from 'ignore';
+import fs from "node:fs";
+import path from "path";
+import { fileURLToPath } from 'url';
 
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
 const ROOT = process.cwd();
 
+
+
 async function emptyDir(dir) {
 	await fsprom.mkdir(dir, { recursive: true });
 	const entries = await fsprom.readdir(dir, { withFileTypes: true });
@@ -172,4 +177,4 @@ const exportDist = async (src, dist, banner = null, options = {}) => {
 	}
 };
 
-module.exports = { exportDist };
+export { exportDist };

package/src/watchers.js

@@ -1,5 +1,5 @@
-const path = require("path");
-const chokidar = require("chokidar");
+import path from "path";
+import chokidar from "chokidar";
 
 function toPosix(p) {
 	return p.replace(/\\/g, "/");
@@ -200,4 +200,4 @@ function createWatchers(rules, options = {}) {
 	};
 }
 
-module.exports = { createWatchers };
+export { createWatchers };