comply anca

Author: TimurRin

.devcontainer/Dockerfile

@@ -1,14 +1,3 @@
-FROM docker.io/ubuntu:22.04
+FROM docker.io/node:22.4.1
 
-ENV NODE_VERSION 22.2.0
-ENV NODE_CHECKSUM sha256:2c6eaf8bfd0f886ed8764ffce19c795e909639105e4056b1d9f8f917bad12cf1
-
-RUN apt-get update \
-  && apt-get install -y git tar gnupg2 \
-  && apt-get clean \
-  && rm -rf /var/lib/apt/lists/*
-ADD --checksum=$NODE_CHECKSUM https://nodejs.org/dist/v${NODE_VERSION}/node-v${NODE_VERSION}-linux-x64.tar.gz /node.tar.gz
-RUN tar -xz -f /node.tar.gz -C /usr/local --remove-files --strip-components=1
-
-RUN useradd -m -s /bin/bash developer
-USER developer
+USER node

.devcontainer/devcontainer.json

@@ -1,5 +1,4 @@
 {
-  "name": "Clivo",
   "build": {
     "context": ".",
     "dockerfile": "./Dockerfile"
@@ -12,5 +11,6 @@
         "streetsidesoftware.code-spell-checker"
       ]
     }
-  }
+  },
+  "name": "Node.js 22"
 }

.github/workflows/release.yml

@@ -3,27 +3,26 @@ name: Release
 on:
   release:
     types: [created]
-  workflow_dispatch:
 
 jobs:
   publish-npm:
     runs-on: ubuntu-latest
+    env:
+      ANCA_CI: true
     name: "Publish package to npm registry"
     steps:
       - uses: actions/checkout@v4
         name: "Checkout repo"
       - uses: actions/setup-node@v4
         with:
-          node-version: 22
+          node-version: 22.4.1
           registry-url: https://registry.npmjs.org/
         name: "Install Node.js"
       - run: npm ci
         name: "Install dependencies"
       - run: npm test
         name: "Run tests"
-      - run: npm run build
-        name: "Build distribution bundle"
       - run: npm publish
         env:
           NODE_AUTH_TOKEN: ${{secrets.npm_token}}
-        name: "Publish to registry"
+        name: "Build and publish to registry"

.github/workflows/test.yml

@@ -3,14 +3,13 @@ name: Test
 on:
   push:
     branches: ["**"]
-  workflow_dispatch:
 
 jobs:
   test-commit:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [18, 20, 22]
+        node: [18.20.4, 20.15.1, 22.4.1]
     name: Test repo on Node.js ${{ matrix.node }}
     steps:
       - uses: actions/checkout@v4

.gitignore

@@ -1,55 +1,55 @@
+# Editor directories and files
+.idea
+.DS_Store
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+.vscode
+
 # Logs
 logs
 *.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-pnpm-debug.log*
-lerna-debug.log*
-report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
-
-# Dependency directories
-node_modules/
-jspm_packages/
-.yarn/cache
-.yarn/unplugged
-.yarn/build-state.yml
-.yarn/install-state.gz
-.pnp.*
-.yarn-integrity
 
 # Runtime data
 pids
 *.pid
 *.seed
 *.pid.lock
 
-# Editor directories and files
-.idea
-.DS_Store
-*.suo
-*.ntvs*
-*.njsproj
-*.sln
-*.sw?
-.vscode
+# Temp folder
+tmp
 
 # Built sources
 /dist
 /build
 *.spec
 
-# Output of 'npm pack'
-*.tgz
+# Dependency directories
+node_modules/
+jspm_packages/
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+.yarn-integrity
 
 # Local settings
 .env
 .env.development.local
 .env.test.local
 .env.production.local
 .env.local
-config.json
 
-# Data
-/data
-/public/assets
+# Node.js logs
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Output of 'npm pack'
+*.tgz

.prettierignore

@@ -14,8 +14,14 @@
 package-lock.json
 
 # Distributions
+/build
 /dist
 
-# Cinnabar Forge
-cinnabar.js
+# Cinnabar Meta
+**/cinnabar.js
+**/cinnabar.ts
 cinnabar.json
+CHANGELOG.md
+
+# Anca
+anca.json

CONTRIBUTING.md

@@ -0,0 +1,22 @@
+# Contributing
+
+Contributions are welcome! If you find any issues or have suggestions for improvements, feel free to open an issue or create a pull request.
+
+## Installation
+
+We support [Devcontainers](https://containers.dev/). You can use the provided development container to work on this project. The development container includes all the necessary tools and dependencies to work on this project.
+
+Otherwise, download, install and configure [Node.js](https://nodejs.org/en/download/).
+
+Then, run the following commands to install the dependencies and run the tests:
+
+```bash
+npm ci
+npm test
+```
+
+## Authors
+
+### Maintainers
+
+- Timur Moziev ([@TimurRin](https://github.com/TimurRin))

README.md

@@ -1,24 +1,20 @@
 # Clivo
 
-_By Cinnabar Forge_
-
-**DISCLAIMER**: Until version 1.0.0, all versions below should be considered unstable.
+> **DISCLAIMER**: This project is not production ready. All versions below 1.0.0 should be considered unstable
 
 Simple CLI tools library
 
-## Getting Started
-
-### Installation
+## Installation
 
-Install clivo using npm:
+### npm
 
 ```bash
 npm install clivo
 ```
 
-### Usage
+## Usage
 
-#### Parsing CLI arguments
+### Parsing CLI arguments
 
 You can assign one or multiple variables to an option in any fashion:
 
@@ -45,6 +41,8 @@ const result = parseCli({
 // result = { _: [ 'burger-earl' ], takeout: [ 'yes' ], order: [ 'burger', 'cola', 'fries', 'salad' ] }
 ```
 
+#### Equal Sign Values Only
+
 Alternatively, you can set values with equal sign only using `equalSignValuesOnly`:
 
 ```javascript
@@ -67,7 +65,9 @@ const result = parseCli({
 // result = { takeout: [ 'yes' ], order: [ 'burger', 'cola', 'fries', 'salad' ], _: [ 'burger-earl' ] }
 ```
 
-#### Prompt
+### Prompt
+
+Prompt the user for input in various ways:
 
 ```javascript
 import { promptOptions } from "clivo";
@@ -128,26 +128,16 @@ await promptMenu("Main Menu", [
 
 ## Contributing
 
-Contributions are welcome! If you find any issues or have suggestions for improvements, feel free to open an issue or create a pull request.
-
-You need Node.js installed on your device.
-
-You can also develop in the Devcontainer mode.
+Visit [`CONTRIBUTING.md`](CONTRIBUTING.md).
 
-After preparations, install:
+Current maintainers:
 
-```bash
-npm ci
-```
-
-### Road to 1.0
-
-`TODO`
+- Timur Moziev ([@TimurRin](https://github.com/TimurRin))
 
 ## License
 
-Clivo is licensed under the ISC License - see the [LICENSE](LICENSE) file for details.
+Visit [`LICENSE`](LICENSE).
 
-## Authors
+## Anca
 
-- Timur Moziev ([@TimurRin](https://github.com/TimurRin))
+This repository is a part of [Anca](https://github.com/cinnabar-forge/anca) standardization project. Parts of the files and code are generated by Anca.

anca.json

@@ -33,6 +33,6 @@
   "development": {
     "readme": {}
   },
-  "type": "app",
+  "type": "library",
   "stack": "nodejs"
 }

eslint.config.js

@@ -1,17 +1,20 @@
 import cinnabarPlugin from "@cinnabar-forge/eslint-plugin";
 
+const files = ["src/**/*.ts"];
+const ignores = ["bin/**/*", "build/**/*", "dist/**/*"];
+
 export default [
   ...cinnabarPlugin.default.map((config) => ({
     ...config,
-    files: ["src/**/*.ts"],
+    files,
   })),
   {
-    files: ["src/**/*.ts"],
+    files,
     rules: {
       "security/detect-object-injection": "off",
     },
   },
   {
-    ignores: ["bin/**/*", "build/**/*", "dist/**/*"],
+    ignores,
   },
 ];

package.json

@@ -21,10 +21,10 @@
   "scripts": {
     "build": "tsup",
     "build:dev": "tsc",
+    "fix": "prettier . --write && eslint --fix .",
     "format": "prettier . --write",
     "lint": "eslint --fix .",
-    "prepack": "npm run build",
-    "test": "eslint --max-warnings 0 . && tsc && mocha './build/dev/test'"
+    "test": "prettier . -c && eslint --max-warnings 0 . && tsc && mocha './build/dev/test'"
   },
   "devDependencies": {
     "@cinnabar-forge/eslint-plugin": "0.6.1",
@@ -41,6 +41,9 @@
     "tsup": "8.2.1",
     "typescript": "5.5.3"
   },
+  "engines": {
+    "node": ">=18"
+  },
   "pre-commit": [
     "format",
     "test"

src/prompts.ts

@@ -10,7 +10,10 @@ const emitter = new EventEmitter();
  * @param {string} event - The event to emit.
  * @param {(...args: unknown[]) => void} listener - The listener to call when the event is emitted.
  */
-export function listenClivoEvent(event: string, listener: (...args: unknown[]) => void): void {
+export function listenClivoEvent(
+  event: string,
+  listener: (...args: unknown[]) => void,
+): void {
   emitter.on(event, listener);
 }
 

tsconfig.json

@@ -1,14 +1,14 @@
 {
   "compilerOptions": {
-    "target": "es2022",
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
     "module": "es2022",
+    "moduleResolution": "node",
     "outDir": "./build/dev",
     "rootDir": "./",
-    "moduleResolution": "node",
-    "strict": true,
-    "esModuleInterop": true,
     "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true
+    "strict": true,
+    "target": "es2022"
   },
-  "include": ["./src/*", "./test/*"]
+  "include": ["./src/**/*", "./test/**/*"]
 }