create-feli 0.1.10 → 0.1.12

package/README.md

@@ -1,48 +1,78 @@
-create-vag
-==========
+create-feli
+===========
 
 
 Presentation
 ------------
 
-*create-vag* is the *initializer* used by *npm* for creating a new [vag](https://github.com/charlyoleg2/vag) repository. It contains the *command line interface* application called by `npm create vag@latest`.
+*create-feli* is the *initializer* used by *npm* for creating a *mini-server* package, usually within a mono-repo. It contains the *command line interface* application called by `npm create feli@latest`.
+The *mini-server* package aims at installing locally *your* webUI. The *mini-server* package should be named according to your project-name (e.g. webAppAbc-uis).
 
 
 Links
 -----
 
-- [sources](https://github.com/charlyoleg2/create-vag)
-- [pkg](https://www.npmjs.com/package/create-vag)
+- [sources](https://github.com/charlyoleg2/feli_mono)
+- [pkg](https://www.npmjs.com/package/create-feli)
+- [pages](https://charlyoleg2.github.io/feli_mono/)
 
 
 Requirements
 ------------
 
-- [node](https://nodejs.org) > 20.10.0
-- [npm](https://docs.npmjs.com/cli) > 10.5.0
+- [node](https://nodejs.org) > 22.0.0
+- [npm](https://docs.npmjs.com/cli) > 11.0.0
+
+
+Getting started
+---------------
+
+```bash
+cd XYZ_mono/pkg/
+npm create feli@latest
+# adjust the script copy_ui for the exact path of copy-from
+vim webAppAbc-uis/package.json
+# integrate the scripts of webAppAbc-uis into the mono-repo top-level scripts
+vim ../package.json
+# install the webAppAbc-uis dependencies
+npm i
+npm run ci
+npm run publish
+```
 
 
 Usage
 -----
 
-*create-vag* is not intended to be installed directly but rather used via one of the following commands:
+*create-feli* is not intended to be installed directly but rather used via one of the following commands:
 
 ```bash
-npm create vag@latest
-npm create vag@latest projAbc
-npm init vag@latest projAbc
-npm exec create-vag@latest projAbc
-npx create-vag@latest projAbc
+npm create feli@latest
+npm create feli@latest webAppAbc-uis
+npm init feli@latest webAppAbc-uis
+npm exec create-feli@latest webAppAbc-uis
+npx create-feli@latest webAppAbc-uis
 ```
 
 Dev
 ---
 
 ```bash
-git clone https://github.com/charlyoleg2/create-vag
-cd create-vag
+git clone https://github.com/charlyoleg2/feli_mono
+cd feli_mono
 npm install
-npm run ci
-npm run run
+npm -w create-feli run ci
+cd pkg/create-feli
+npm run clean && npm i && npm run ci && npm run run
 ```
 
+Rocket stages:
+1. npm clean  # start from a clean environment
+2. npm i  # install the dependencies of create-feli and in particular those inside feli\_mono/pkg/create-feli/node\_modules
+3. npm run ci  # compile create-feli.ts into javascript and copy the directory template
+4. npm run run  # execute the javascript create-feli.js that generates the directory tmp/webAppAbc-uis
+5. cd tmp/webAppAbc-uis  # move to the generated package
+6. npm i  # install the dependencies of the generated package
+7. npm run ci  # compile the generated mini-server
+8. npm run run  # run the mini-server
+

package/dist/create-feli-cli.js

@@ -7,7 +7,7 @@ import chalk from "chalk";
 // package.json
 var package_default = {
   name: "create-feli",
-  version: "0.1.10",
+  version: "0.1.12",
   description: "The npm-initializer for creating a new feli package",
   private: false,
   repository: {
@@ -89,16 +89,16 @@ var package_default = {
   devDependencies: {
     "@eslint/js": "^9.28.0",
     "@types/eslint__js": "^8.42.3",
-    "@types/node": "^24.0.7",
-    eslint: "^9.28.0",
+    "@types/node": "^24.0.10",
+    eslint: "^9.30.1",
     "eslint-config-prettier": "^10.1.5",
-    "npm-run-all": "^4.1.5",
-    prettier: "^3.5.3",
+    "npm-run-all2": "^8.0.4",
+    prettier: "^3.6.2",
     shx: "^0.4.0",
     tsup: "^8.5.0",
     typescript: "^5.8.3",
-    "typescript-eslint": "^8.33.1",
-    vitest: "^3.2.2"
+    "typescript-eslint": "^8.35.1",
+    vitest: "^3.2.4"
   }
 };
 
@@ -133,11 +133,14 @@ function prefixOutputPath() {
 
 // src/create-feli-list.ts
 var template_file_list = [
-  ".editorconfig",
   ".gitignore",
-  "package.json",
+  ".prettierignore",
   "README.md",
-  "{{projName}}_repos.yml"
+  "eslint.config.js",
+  "package.json",
+  "tsconfig.json",
+  "src/{{pkgName}}.test.ts",
+  "src/{{pkgName}}.ts"
 ];
 
 // src/create-feli-api.ts
@@ -160,15 +163,14 @@ function isFileBinary(fpath) {
 async function oneFile(onePath, cfg2, preDir2) {
   try {
     const onePathIn = Handlebars.compile(onePath)({
-      projName: "projAbc",
-      repoName: "projAbc-uis"
+      pkgName: "webAppAbc-uis"
     });
     const onePathOut = Handlebars.compile(onePath)(cfg2);
     const fileIn1 = new URL(`./template/${onePathIn}.handlebars`, import.meta.url);
     const fileIn2 = new URL(`./template/${onePathIn}`, import.meta.url);
     let fileBin = false;
     let fileStr2 = "";
-    const outPath = `${preDir2}/${cfg2.repoName}/${onePathOut}`;
+    const outPath = `${preDir2}/${cfg2.pkgName}/${onePathOut}`;
     try {
       await access(fileIn1);
       try {
@@ -203,47 +205,38 @@ async function oneFile(onePath, cfg2, preDir2) {
 }
 async function generate_boirlerplate(cfg12, preDir2) {
   console.log(`Boilerplate with:
-  project name     : ${cfg12.projName}
-  repository name  : ${cfg12.repoName}`);
+  package name     : ${cfg12.pkgName}`);
   const cfg2 = {
-    projName: cfg12.projName,
-    ProjName: firstLetterCapital(cfg12.projName),
-    ProjNameUnderline: underline(cfg12.projName),
-    repoName: cfg12.repoName,
-    RepoName: firstLetterCapital(cfg12.repoName),
-    RepoNameUnderline: underline(cfg12.repoName)
+    pkgName: cfg12.pkgName,
+    PkgName: firstLetterCapital(cfg12.pkgName),
+    PkgNameUnderline: underline(cfg12.pkgName)
   };
   for (const fpath of template_file_list) {
     await oneFile(fpath, cfg2, preDir2);
   }
-  console.log(`generate ${template_file_list.length} files in ${preDir2}/${cfg12.repoName}/`);
+  console.log(`generate ${template_file_list.length} files in ${preDir2}/${cfg12.pkgName}/`);
   await sleep(100);
   const rResp = {
-    vim: `vim ${cfg12.projName}_repos.yml`
+    vim: `vim ${cfg12.pkgName}/package.json`
   };
   return rResp;
 }
 
 // src/create-feli-cli.ts
-var firstMsg = `Create a new ${chalk.italic("feli-top-repo")} with ${chalk.italic(package_default.name)} version ${chalk.italic(package_default.version)}`;
+var firstMsg = `Create a new ${chalk.italic("feli-package")} with ${chalk.italic(package_default.name)} version ${chalk.italic(package_default.version)}`;
 console.log(firstMsg);
-var projName = process.argv[2] || "blabla";
+var pkgNameInit = process.argv[2] || "webAppAbc-uis";
 var argN = process.argv.length - 2;
 if (argN > 1) {
   console.log(`warn376: ${argN} arguments provided but only one supported!`);
 }
-prom.intro(chalk.inverse(" Your new feli-top-repo "));
+prom.intro(chalk.inverse(" Your new feli-package "));
 var pCfg = await prom.group(
   {
-    projName: () => prom.text({
-      message: "Name of the project?",
-      initialValue: `${projName}`
-      //placeholder: `${projName}`
-    }),
-    repoName: () => prom.text({
-      message: "Name of the top-repository?",
-      initialValue: `${projName}_uis`
-      //placeholder: `${projName}_uis`
+    pkgName: () => prom.text({
+      message: "Name of the package?",
+      initialValue: `${pkgNameInit}`
+      //placeholder: `${pkgNameInit}`
     })
   },
   {
@@ -253,10 +246,9 @@ var pCfg = await prom.group(
     }
   }
 );
-prom.outro("Your new feli-top-repository will be boilerplated!");
+prom.outro(`Your package ${pCfg.pkgName} will be boilerplated!`);
 var cfg1 = {
-  projName: pCfg.projName,
-  repoName: pCfg.repoName
+  pkgName: pCfg.pkgName
 };
 var preDir = prefixOutputPath();
 var resp = await generate_boirlerplate(cfg1, preDir);
@@ -267,15 +259,11 @@ function styl(str) {
 }
 var lastMsg = `
 Next steps:
-  1: ${styl(`cd ${pCfg.repoName}`)}
-  2: ${styl(`npm install`)}
-  3: ${styl('git init && git add -A && git commit -m "Initial commit"')} (optional)
-  4: ${styl(`${resp.vim}`)} (optional)
-  5: ${styl(`npm run`)}
-  6: ${styl(`npm run vag-list`)}
-  7: ${styl(`npm run vag-clone`)}
-  8: ${styl(`npm run vag-pull`)}
-  9: ${styl(`npm run vag-status`)}
- 10: ${styl(`npm run vag-diff`)}
+  1: ${styl(`# adapt the path of copy-from`)}
+     ${resp.vim}
+  2: ${styl(`# integrate ${pCfg.pkgName} in the mono-repo scripts`)}
+     vim ../package.json
+  3: ${styl(`# install the dependencies of ${pCfg.pkgName}`)}
+     npm install
 `;
 console.log(lastMsg);

package/dist/template/.gitignore.handlebars

@@ -1,6 +1,5 @@
-# .gitignore of vag-root
-node_modules
-build
-dist
-tmp
-/repos/
+# .gitignore of the package {{pkgName}}
+dist/
+dist2/
+# vitest creates node_modules for the results.json
+node_modules/

package/dist/template/.prettierignore

@@ -0,0 +1,7 @@
+# .prettierignore
+
+node_modules
+build
+dist
+tmp
+README.md

package/dist/template/README.md.handlebars

@@ -1,30 +1,45 @@
-{{ProjName}}\_vag
-{{{ProjNameUnderline}}}=====
+{{PkgName}}
+{{{PkgNameUnderline}}}
 
 
 Presentation
 ------------
 
-*{{projName}}\_vag* is the top-repo of the *{{ProjName}}* ecosystem. It just points to other repositories.
+*{{pkgName}}* is the mini-server package for enabling the local installation of the web-ui.
 
-Using [vag\_tools](https://www.npmjs.com/package/vag_tools), it clones the following repositories:
+Usually, this mini-server package {{pkgName}} is part of a mono-repo containing an other package for the web-ui and potentially an *universal* library backing the web-ui.
 
-- {{projName}}
-- create-{{projName}}
-- {{projName}}\_vag
+
+Requirements
+------------
+
+- [node](https://nodejs.org) > 22.0.0
+- [npm](https://docs.npmjs.com/cli) > 11.0.0
+
+
+Installation
+------------
+
+```bash
+npm i -D {{pkgName}}
+```
+
+
+Usage
+-----
+
+```bash
+npx {{pkgName}}
+npx {{pkgName}} --help
+```
 
 
-Getting started
----------------
+Usage without installation
+--------------------------
 
 ```bash
-git clone https://github.com/MYNAME/{{projName}}_vag
-cd {{projName}}_vag
-npm i
-npm run
-npm run vag-clone
-npm run vag-pull
-ls -la repos
-npx vag --help
+npx {{pkgName}}
+npx --package={{pkgName}} {{pkgName}}
+npx --package={{pkgName}} {{pkgName}} --help
 ```
 

package/dist/template/eslint.config.js

@@ -0,0 +1,16 @@
+// @ts-check
+
+import eslint from '@eslint/js';
+import tseslint from 'typescript-eslint';
+import prettier from 'eslint-config-prettier';
+
+export default tseslint.config(
+	{
+		ignores: ['dist/', 'tmp/', 'build/', 'node_modules/']
+	},
+	eslint.configs.recommended,
+	//...tseslint.configs.recommended,
+	...tseslint.configs.strict,
+	...tseslint.configs.stylistic,
+	prettier
+);

package/dist/template/package.json.handlebars

@@ -1,35 +1,90 @@
 {
-	"name": "{{projName}}_vag",
-	"version": "0.0.1",
-	"description": "top-repo that points to the other {{projName}} repositories",
-	"private": true,
+	"name": "{{pkgName}}",
+	"description": "feli-package {{pkgName}} for installing locally the web-ui webAppAbc",
+	"version": "0.1.0",
+	"private": false,
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/MYNAME/{{projName}}_vag.git"
+		"url": "git+https://github.com/MYNAME/XYZ_mono.git"
 	},
-	"homepage": "https://github.com/MYNAME/{{projName}}_vag#readme",
+	"homepage": "https://MYNAME.github.io/XYZ_mono/",
 	"author": "MYNAME",
 	"license": "ISC",
 	"keywords": [
-		"{{projName}}",
-		"vag"
+		"feli",
+		"front-end locally installed"
 	],
 	"type": "module",
-	"main": "index.js",
+	"exports": {
+		".": {
+			"types": "./dist/{{pkgName}}.d.ts",
+			"default": "./dist/{{pkgName}}.js"
+		}
+	},
+	"bin": {
+		"{{pkgName}}": "dist/{{pkgName}}.js"
+	},
+	"files": [
+		"dist/",
+		"!dist/**/*.d.ts",
+		"!dist/**/*.map",
+		"!dist/**/*.test.*",
+		"!dist/**/*.spec.*"
+	],
+	"engines": {
+		"node": ">=22.0.0"
+	},
+	"tsup": {
+		"entry": [
+			"src/{{pkgName}}.ts"
+		],
+		"format": "esm",
+		"splitting": false,
+		"dts": false,
+		"sourcemap": false,
+		"clean": true
+	},
+	"prettier": {
+		"useTabs": true,
+		"singleQuote": true,
+		"trailingComma": "none",
+		"printWidth": 100,
+		"plugins": [],
+		"overrides": []
+	},
 	"scripts": {
-		"vag-list": "vag --importYaml={{projName}}_repos.yml list",
-		"vag-clone": "vag --importYaml={{projName}}_repos.yml clone",
-		"vag-status": "vag --importYaml={{projName}}_repos.yml --only_configured status",
-		"vag-diff": "vag --importYaml={{projName}}_repos.yml --only_configured diff",
-		"vag-branch": "vag branch",
-		"vag-remote": "vag remote",
-		"vag-pull": "vag pull",
-		"vag-push": "vag push",
-		"vag-verify": "vag verify --importYaml={{projName}}_repos.yml",
-		"vag-versions": "vag versions",
-		"test": "echo \"Error: no test specified\" && exit 1"
+		"dev": "tsup --watch",
+		"build": "tsup",
+		"check": "tsc --noEmit",
+		"pretty": "prettier --check .",
+		"format": "prettier --write .",
+		"lint": "eslint .",
+		"test:unit": "vitest",
+		"test:unit:once": "vitest --run",
+		"clean_public": "rimraf dist/public",
+		"copy_ui": "shx cp -r ../myWebUI/build dist/public",
+		"checkCopy": "ls -l dist/public/index.html",
+		"copy_public": "run-s clean_public copy_ui checkCopy",
+		"ci": "run-s check build pretty lint test:unit:once copy_public",
+		"run": "node dist/{{pkgName}}.js",
+		"run-help": "node dist/{{pkgName}}.js --help",
+		"clean": "rimraf node_modules build dist tmp"
+	},
+	"dependencies": {
+		"feli": "^0.5.3"
 	},
 	"devDependencies": {
-		"vag_tools": "^0.1.0"
+		"@eslint/js": "^9.10.0",
+		"@types/eslint__js": "^8.42.3",
+		"eslint": "^9.30.1",
+		"eslint-config-prettier": "^10.1.5",
+		"npm-run-all2": "^8.0.4",
+		"prettier": "^3.6.2",
+		"rimraf": "^6.0.1",
+		"shx": "^0.4.0",
+		"tsup": "^8.5.0",
+		"typescript": "^5.8.3",
+		"typescript-eslint": "^8.35.1",
+		"vitest": "^3.2.4"
 	}
 }

package/dist/template/src/webAppAbc-uis.test.ts.handlebars

@@ -0,0 +1,8 @@
+import { describe, it, expect } from 'vitest';
+//import * from './{{pkgName}}'
+
+describe('sum test', () => {
+	it('adds 1 + 2 to equal 3', () => {
+		expect(1 + 2).toBe(3);
+	});
+});

package/dist/template/src/webAppAbc-uis.ts.handlebars

@@ -0,0 +1,17 @@
+#!/usr/bin/env node
+// {{pkgName}}.ts
+
+import { feli_cli } from 'feli';
+import process from 'node:process';
+import path from 'node:path';
+
+const scrDir = import.meta.dirname;
+const defaultPublicDir = path.join(scrDir, 'public');
+
+//console.log('{{pkgName}}.ts says Hello!');
+try {
+	await feli_cli(defaultPublicDir, process.argv);
+} catch (err) {
+	console.error(`Error from feli: ${err}`);
+}
+//console.log('{{pkgName}}.ts says Bye!');

package/dist/template/tsconfig.json

@@ -0,0 +1,15 @@
+{
+	"compilerOptions": {
+		"target": "esnext",
+		"module": "esnext",
+		"outDir": "./build",
+		"esModuleInterop": true,
+		"resolveJsonModule": true,
+		"moduleResolution": "bundler",
+		"skipLibCheck": true,
+		"declaration": true,
+		"sourceMap": true,
+		"strict": true
+	},
+	"include": ["./src"]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "create-feli",
-	"version": "0.1.10",
+	"version": "0.1.12",
 	"description": "The npm-initializer for creating a new feli package",
 	"private": false,
 	"repository": {
@@ -82,15 +82,15 @@
 	"devDependencies": {
 		"@eslint/js": "^9.28.0",
 		"@types/eslint__js": "^8.42.3",
-		"@types/node": "^24.0.7",
-		"eslint": "^9.28.0",
+		"@types/node": "^24.0.10",
+		"eslint": "^9.30.1",
 		"eslint-config-prettier": "^10.1.5",
-		"npm-run-all": "^4.1.5",
-		"prettier": "^3.5.3",
+		"npm-run-all2": "^8.0.4",
+		"prettier": "^3.6.2",
 		"shx": "^0.4.0",
 		"tsup": "^8.5.0",
 		"typescript": "^5.8.3",
-		"typescript-eslint": "^8.33.1",
-		"vitest": "^3.2.2"
+		"typescript-eslint": "^8.35.1",
+		"vitest": "^3.2.4"
 	}
 }

package/dist/template/.editorconfig

@@ -1,23 +0,0 @@
-# .editorconfig of vag-root
-# EditorConfig is awesome: https://EditorConfig.org
-# don't forget the vim-plugin for it
-
-# top-most EditorConfig file
-root = true
-
-# Unix-style newlines with a newline ending every file
-[*]
-indent_style = tab
-indent_size = 4
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-
-# Tab indentation (no size specified)
-[Makefile]
-indent_style = tab
-
-# yaml indentation with spaces
-[*.{yml,yaml}]
-indent_style = space

package/dist/template/projAbc_repos.yml.handlebars

@@ -1,13 +0,0 @@
-# {{projName}}_repos.yml
-
-repositories:
-  repos/{{projName}}:
-    type: git
-    url: git@github.com:MYNAME/{{projName}}.git
-    version: main
-  repos/create-{{projName}}:
-    url: git@github.com:MYNAME/create-{{projName}}.git
-    version: main
-  repos/{{projName}}_vag:
-    url: git@github.com:MYNAME/{{projName}}_vag.git
-    version: main