semlog 0.7.0 → 0.8.0

package/.github/workflows/ci.yml

@@ -15,7 +15,10 @@ jobs:
 
     strategy:
       matrix:
-        node: [20, 22]
+        include:
+          - node: 20
+          - node: 22
+            coverage: true
 
     steps:
       - name: Checkout
@@ -37,3 +40,15 @@ jobs:
 
       - name: Test
         run: npm test
+        if: matrix.coverage != true
+
+      - name: Test with coverage
+        run: npm run test:coverage
+        if: matrix.coverage == true
+
+      - name: Upload code coverage
+        uses: codecov/codecov-action@v4
+        with:
+          files: coverage/clover.xml
+          token: ${{ secrets.CODECOV_TOKEN }}
+        if: matrix.coverage == true

package/.github/workflows/publish.yml

@@ -31,7 +31,6 @@ jobs:
         run: |
           corepack enable npm
           corepack prepare npm@^11 --activate
-          npm --version
 
       - name: Install dependencies
         run: npm ci
@@ -42,5 +41,4 @@ jobs:
       - name: Publish
         run: |
           unset NODE_AUTH_TOKEN
-          npm --version
           npm publish --access public

package/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+This project adheres to [Semantic Versioning](https://semver.org/) and
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
+
+## [Unreleased]
+
+## [0.8.0] - 2026-07-26
+
+Adds a coverage report to CI and closes out a set of open dependency vulnerabilities.
+
+### Added
+- Add `format` npm script for auto-formatting with Prettier [`dbffe72`](https://github.com/gesinn-it-pub/semlog/commit/dbffe724b95dae9870e5114ed272c5df34ee7998)
+
+### Changed
+- Bump mocha to 11.7.6 and override vulnerable transitive deps (brace-expansion, diff, js-yaml, serialize-javascript) [`39d2837`](https://github.com/gesinn-it-pub/semlog/commit/39d28378b0a21e5a9963392163961aa40b0ba68f)
+
+[Unreleased]: https://github.com/gesinn-it-pub/semlog/compare/0.8.0...HEAD
+[0.8.0]: https://github.com/gesinn-it-pub/semlog/compare/v0.6.11...0.8.0

package/Makefile

@@ -5,6 +5,10 @@ ci: lint format-check test
 lint:
 	npm run lint
 
+.PHONY: format
+format:
+	npm run format
+
 .PHONY: format-check
 format-check:
 	npm run format:check

package/README.md

@@ -1,5 +1,6 @@
 [![npm version](https://img.shields.io/npm/v/semlog.svg?style=flat)](https://www.npmjs.com/package/semlog)
 [![CI](https://github.com/gesinn-it-pub/semlog/actions/workflows/ci.yml/badge.svg)](https://github.com/gesinn-it-pub/semlog/actions/workflows/ci.yml)
+[![codecov](https://codecov.io/github/gesinn-it-pub/semlog/branch/master/graph/badge.svg)](https://codecov.io/github/gesinn-it-pub/semlog)
 > A semantic logger module, that colors / formats automatically
 
 ## About

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "semlog",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "A semantic logger module, that colors and formats automatically depending on the content",
   "homepage": "https://github.com/gesinn-it-pub/semlog",
   "author": {
@@ -45,11 +45,20 @@
     "eslint": "^10.0.0",
     "eslint-config-prettier": "^10.0.0",
     "globals": "^17.0.0",
-    "mocha": "^11.0.0",
+    "mocha": "^11.7.6",
     "prettier": "^3.0.0"
   },
+  "overrides": {
+    "mocha": {
+      "diff": "^8.0.4",
+      "js-yaml": "^4.3.0",
+      "serialize-javascript": "^7.0.7"
+    },
+    "brace-expansion": "^5.0.8"
+  },
   "scripts": {
     "lint": "eslint index.js test/",
+    "format": "prettier --write index.js test/",
     "format:check": "prettier --check index.js test/",
     "test": "mocha 'test/**/*.spec.js'",
     "test:coverage": "c8 mocha 'test/**/*.spec.js'"

package/.github/workflows/build-agents.yml

@@ -1,55 +0,0 @@
-name: Build AGENTS
-
-on:
-  push:
-    paths:
-      - AGENTS-source.adoc
-      - docs/attributes.adoc
-      - docs/gesinn-it-docs-master-pub
-      - docs/gesinn-it-docs-master-pub/**
-    branches:
-      - '**'
-  workflow_dispatch:
-
-jobs:
-
-  build:
-    timeout-minutes: 10
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-        with:
-          submodules: 'true'
-
-      - name: Install tools
-        run: |
-          sudo apt-get update
-          sudo apt-get install -y asciidoctor pandoc
-          sudo gem install asciidoctor-reducer --pre
-
-      - name: Reduce AGENTS source (flatten includes)
-        run: asciidoctor-reducer -o AGENTS.adoc AGENTS-source.adoc
-
-      - name: Convert AsciiDoc to DocBook
-        run: asciidoctor -b docbook5 -o AGENTS.xml AGENTS.adoc
-
-      - name: Convert DocBook to Markdown
-        run: pandoc -f docbook -t gfm AGENTS.xml -o AGENTS.md
-
-      - name: Add autogenerated header (AGENTS)
-        run: |
-          printf "<!-- THIS FILE IS AUTO-GENERATED. Edit AGENTS-source.adoc instead. -->\n\n" | \
-          cat - AGENTS.md > tmp
-          mv tmp AGENTS.md
-
-      - name: Remove intermediate files
-        run: rm -f AGENTS.adoc AGENTS.xml
-
-      - name: Commit generated files
-        uses: EndBug/add-and-commit@v8
-        with:
-          add: AGENTS.md
-          pull: '--rebase --autostash'
-          message: "docs(ci): update generated AGENTS.md [skip ci]"

package/.gitmodules

@@ -1,3 +0,0 @@
-[submodule "docs/gesinn-it-docs-master-pub"]
-	path = docs/gesinn-it-docs-master-pub
-	url = https://github.com/gesinn-it-pub/gesinn-it-docs-master-pub.git

package/AGENTS-source.adoc

@@ -1,31 +0,0 @@
-// ============================================================
-// THIS IS THE SOURCE FILE. Edit this file only.
-// AGENTS.md is AUTO-GENERATED by the GitHub
-// workflow .github/workflows/build-agents.yml.
-// NEVER edit or regenerate AGENTS.md manually.
-// ============================================================
-include::docs/attributes.adoc[]
-
-== Coding Conventions
-
-include::docs/gesinn-it-docs-master-pub/snippets/{project_type}/coding-conventions.adoc[]
-
-== Test Workflow
-
-include::docs/gesinn-it-docs-master-pub/snippets/nodejs/ci-npm.adoc[]
-
-== Commit Convention
-
-include::docs/gesinn-it-docs-master-pub/sections/universal/conventional-commits-policy.adoc[]
-
-== Publish Workflow
-
-include::docs/gesinn-it-docs-master-pub/snippets/nodejs/ci-publish.adoc[]
-
-== Release Workflow
-
-include::docs/gesinn-it-docs-master-pub/sections/nodejs/release-workflow.adoc[]
-
-== Versioning
-
-include::docs/gesinn-it-docs-master-pub/sections/universal/semver-policy.adoc[]

package/AGENTS.md

@@ -1,343 +0,0 @@
-<!-- THIS FILE IS AUTO-GENERATED. Edit AGENTS-source.adoc instead. -->
-
-# Coding Conventions
-
-**Coding Conventions — General**
-
-All source files regardless of language must follow these baseline
-rules.
-
-- Encoding: UTF-8 without BOM
-
-- Line endings: Unix-style LF (not CR+LF)
-
-- Maximum line length: 120 characters
-
-- No trailing whitespace
-
-- Newline at end of file
-
-**Coding Conventions — JavaScript**
-
-Tooling: [ESLint v9](https://eslint.org/) (code quality) +
-[Prettier](https://prettier.io/) (formatting). Run locally:
-`npm run lint` / `npm run format:check` (or `npm test`).
-
-Target: Node.js 20+. Declare in `package.json`:
-
-``` json
-"engines": { "node": ">=20.0.0" }
-```
-
-**ESLint — flat config (v9+)**
-
-New repositories use [flat
-config](https://eslint.org/docs/latest/use/configure/configuration-files)
-(`eslint.config.js`). Install:
-`npm install --save-dev eslint @eslint/js globals eslint-config-prettier`
-
-``` js
-// eslint.config.js
-import js from '@eslint/js';
-import globals from 'globals';
-import prettier from 'eslint-config-prettier';
-
-export default [
-    js.configs.recommended,
-    {
-        languageOptions: {
-            globals: globals.node,
-            ecmaVersion: 2022,
-        },
-        rules: {
-            'no-unused-vars': ['warn', { argsIgnorePattern: '^_' }],
-            'no-console': 'off',
-            'prefer-const': 'error',
-        },
-    },
-    prettier, // disables ESLint rules that conflict with Prettier
-];
-```
-
-<div class="note">
-
-Projects with `"type": "commonjs"` in `package.json` must use CJS syntax
-in `eslint.config.js` (`require` / `module.exports`).
-
-</div>
-
-Run: `npm run lint` (`eslint src/ test/`).
-
-**Prettier — code formatting**
-
-Formatting (indentation, quotes, line length) is owned by Prettier, not
-ESLint rules. Install: `npm install --save-dev --save-exact prettier`
-
-``` json
-// .prettierrc
-{
-  "singleQuote": true,
-  "semi": true,
-  "tabWidth": 4,
-  "printWidth": 120,
-  "trailingComma": "es5"
-}
-```
-
-Format: `prettier --write src/ test/`  
-Check (CI): `prettier --check src/ test/`
-
-**Module system**
-
-- New projects: ES Modules (`import` / `export`) with `"type": "module"`
-  in `package.json`
-
-- Existing CommonJS code (`require` / `module.exports`) does not need to
-  migrate
-
-- One concern per file; filename reflects its exported symbol
-  (`BotRequest.js` for class `BotRequest`)
-
-**Naming**
-
-- Variables and functions: lowerCamelCase
-
-- Constructors / classes: UpperCamelCase
-
-- Constants: `ALL_CAPS`
-
-- Acronyms as single words: `getHtmlSource`, not `getHTMLSource`
-
-**Code style**
-
-- `const` and `let` — never `var`
-
-- `===` and `!==` always; no Yoda conditions
-
-- Arrow functions for callbacks; async/await over raw Promise chains
-
-- Optional chaining (`?.`) and nullish coalescing (`??`) over manual
-  null checks
-
-- Early returns over deeply nested `if` blocks
-
-- JSDoc type annotations on public API functions encouraged
-
-# Test Workflow
-
-**Install dependencies**
-
-``` console
-npm ci
-```
-
-Run all checks (lint + format check + tests):
-
-``` console
-npm test
-```
-
-Run only ESLint:
-
-``` console
-npm run lint
-```
-
-Check formatting (Prettier, non-destructive):
-
-``` console
-npm run format:check
-```
-
-**Pre-commit gate**
-
-Run before every commit:
-
-``` console
-make ci 2>&1 | tee /tmp/ci.log; echo "EXIT:$?"
-```
-
-Auto-format source files:
-
-``` console
-npm run format
-```
-
-Run tests with coverage report:
-
-``` console
-npm run test-coverage
-```
-
-# Commit Convention
-
-# Conventional Commits Policy
-
-Commit messages follow the [Conventional Commits
-specification](https://www.conventionalcommits.org/).
-
-Commit format:
-
-`type(scope): short description`
-
-The scope is optional and should describe the affected subsystem,
-module, or dependency when useful.
-
-Examples:
-
-- feat(api): add autocomplete endpoint
-
-- fix(parser): handle empty token lists
-
-- docs(readme): explain input architecture
-
-- refactor(parser): simplify token parsing
-
-- deps(smw): bump from 5.1.0 to 5.2.0
-
-- ci(github): update workflow configuration
-
-- test(api): add autocomplete tests
-
-Recommended commit types:
-
-- `feat` — new functionality
-
-- `fix` — bug fixes
-
-- `deps` — dependency updates
-
-- `docs` — documentation changes
-
-- `refactor` — internal code changes without behavioral change
-
-- `test` — tests added or updated
-
-- `ci` — changes to continuous integration configuration
-
-- `chore` — repository maintenance tasks without impact on runtime
-  behavior
-
-Dependency updates:
-
-- Use the `deps` type for dependency upgrades
-
-- The scope should identify the dependency being updated
-
-- Include the version change when applicable
-
-Example:
-
-- deps(smw): bump from 5.1.0 to 5.2.0
-
-Guidelines:
-
-- Use the imperative mood (e.g. "add feature", not "added feature")
-
-- Keep the subject line concise
-
-- Use the commit body to explain **why**, not only **what**
-
-- Scopes should be short, lowercase identifiers (e.g. `api`, `parser`,
-  `smw`, `mediawiki`, `docker`)
-
-- Use `chore` only for repository maintenance tasks that do not affect
-  runtime behavior, dependencies, CI configuration, or tests
-
-# Publish Workflow
-
-**Publish workflow**
-
-Publishing is triggered automatically when a GitHub Release is
-published. The workflow runs all tests before publishing.
-
-**Registry:** [npmjs.org](https://www.npmjs.com)
-
-Authentication uses [npm
-provenance](https://docs.npmjs.com/generating-provenance-statements) via
-OIDC (OpenID Connect) — no static `NPM_TOKEN` secret is required.
-
-The package must be configured as a Trusted Publisher on npmjs.org
-(one-time setup per package): npmjs.org → Package Settings → Publishing
-→ Trusted Publishers → add this repository.
-
-# Release Workflow
-
-# Release Workflow
-
-## Steps
-
-1.  Bump version in `package.json` (no git tag, no commit):
-
-    ``` console
-    npm version <major|minor|patch> --no-git-tag-version
-    ```
-
-2.  Commit:
-
-        prepared x.x.x [skip ci]
-
-3.  Draft release notes (see below) and present for approval.
-
-4.  After explicit user approval — push and create GitHub release:
-
-    ``` console
-    git push
-    gh release create x.x.x --title "x.x.x" --notes "<release notes>"
-    ```
-
-    Creating the GitHub release triggers the publish workflow
-    automatically.
-
-## Release notes
-
-List commits since the last release tag as bullet points, grouped by
-type. Include the short commit SHA in parentheses.
-
-Present release notes inside a fenced markdown code block for easy
-copying. Wait for explicit user approval before pushing or creating the
-GitHub release.
-
-Example:
-
-``` markdown
-## Features
-- feat(api): add new endpoint for autocomplete (a1b2c3d)
-
-## Fixes
-- fix(parser): handle empty token list (e4f5g6h)
-```
-
-# Versioning
-
-# Versioning and Releases
-
-This project follows [Semantic Versioning](https://semver.org/).
-
-Version numbers follow the format:
-
-`MAJOR.MINOR.PATCH`
-
-Version increment rules:
-
-- MAJOR — incompatible or breaking changes
-
-- MINOR — backwards-compatible feature additions
-
-- PATCH — backwards-compatible bug fixes
-
-Breaking changes include (but are not limited to):
-
-- incompatible API changes
-
-- removal or renaming of public interfaces
-
-- behavior changes that may break existing integrations
-
-- increased minimum runtime or dependency requirements
-
-- incompatible configuration or data format changes
-
-- dependency upgrades that introduce breaking changes for users
-
-Breaking changes must always increment the MAJOR version.

package/docs/attributes.adoc

@@ -1,3 +0,0 @@
-:project_name: semlog
-:project_type: nodejs
-:npm-registry: npmjs