semlog 0.6.10 → 0.7.0

package/.editorconfig

@@ -1,12 +1,19 @@
-root = true
-
-[*]
-indent_style = space
-indent_size = 4
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-
-[*.md]
-trim_trailing_whitespace = false
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.yml]
+indent_style = space
+indent_size = 2
+
+[Makefile]
+indent_style = tab

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

@@ -0,0 +1,55 @@
+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/.github/workflows/ci.yml

@@ -0,0 +1,39 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+  workflow_dispatch:
+
+jobs:
+
+  ci:
+    name: "Node ${{ matrix.node }}"
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node: [20, 22]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node }}
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Lint
+        run: npm run lint
+
+      - name: Format check
+        run: npm run format:check
+
+      - name: Test
+        run: npm test

package/.github/workflows/publish.yml

@@ -0,0 +1,46 @@
+## https://github.com/gesinn-it-pub/semlog
+
+name: Publish to npm
+
+on:
+  release:
+    types:
+      - published
+
+jobs:
+
+  publish:
+    name: Publish to npmjs.org
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      id-token: write  # Required for npm provenance (OIDC)
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Upgrade npm (Trusted Publishing requires npm >= 11.5.1)
+        run: |
+          corepack enable npm
+          corepack prepare npm@^11 --activate
+          npm --version
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Test
+        run: npm test
+
+      - name: Publish
+        run: |
+          unset NODE_AUTH_TOKEN
+          npm --version
+          npm publish --access public

package/.gitmodules

@@ -0,0 +1,3 @@
+[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/.prettierrc

@@ -0,0 +1,7 @@
+{
+  "singleQuote": true,
+  "semi": true,
+  "tabWidth": 4,
+  "printWidth": 120,
+  "trailingComma": "es5"
+}

package/AGENTS-source.adoc

@@ -0,0 +1,31 @@
+// ============================================================
+// 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

@@ -0,0 +1,343 @@
+<!-- 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/Makefile

@@ -0,0 +1,14 @@
+.PHONY: ci
+ci: lint format-check test
+
+.PHONY: lint
+lint:
+	npm run lint
+
+.PHONY: format-check
+format-check:
+	npm run format:check
+
+.PHONY: test
+test:
+	npm test

package/README.md

@@ -1,8 +1,5 @@
 [![npm version](https://img.shields.io/npm/v/semlog.svg?style=flat)](https://www.npmjs.com/package/semlog)
-[![Dependency Status](https://img.shields.io/david/Fannon/semlog.svg?style=flat)](https://david-dm.org/Fannon/semlog)
-[![Build Status](https://img.shields.io/travis/Fannon/semlog.svg?style=flat)](http://travis-ci.org/Fannon/semlog)
-[![Code Climate](https://codeclimate.com/github/Fannon/semlog/badges/gpa.svg)](https://codeclimate.com/github/Fannon/semlog)
-[![Test Coverage](https://codeclimate.com/github/Fannon/semlog/badges/coverage.svg)](https://codeclimate.com/github/Fannon/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)
 > A semantic logger module, that colors / formats automatically
 
 ## About
@@ -22,8 +19,8 @@ $ npm install --save semlog
 
 ### Import 
 ```javascript
-var semlog = require('semlog');
-var log = semlog.log; // Optional shortcut for logging
+const semlog = require('semlog');
+const log = semlog.log; // Optional shortcut for logging
 ```
 
 ### Logging
@@ -49,10 +46,10 @@ log('[TODO] todo log entry');
 ### Logger functions
 ```javascript
 // Returns an array with the latest log messages (depending on the config.
-var logArchive = semlog.getLogHistory();
+const logArchive = semlog.getLogHistory();
 
 // Get current logger config
-var config = semlog.getConfig();
+const config = semlog.getConfig();
 
 // Change default options:
 // This will only update the option that are actually given
@@ -69,16 +66,9 @@ semlog.updateConfig({
 ### Helper Functions and more examples
 semlog has some built in helper functions like returning nicely formatted dates.
 
-For a complete API Doc, please view the [API docs](https://cdn.rawgit.com/Fannon/semlog/master/doc/).
+For a complete API Doc, please view the [API docs](API.md).
 
-More example can be found in the [unit test](https://github.com/Fannon/semlog/blob/master/test/test.spec.js) file.
+More examples can be found in the [unit test](https://github.com/gesinn-it-pub/semlog/blob/master/test/test.spec.js) file.
 
 ## License
 MIT © [Simon Heimler](http://www.fannon.de)
-
-[npm-image]: https://badge.fury.io/js/semlog.svg
-[npm-url]: https://npmjs.org/package/semlog
-[travis-image]: https://travis-ci.org/Fannon/semlog.svg?branch=master
-[travis-url]: https://travis-ci.org/Fannon/semlog
-[daviddm-image]: https://david-dm.org/Fannon/semlog.svg?theme=shields.io
-[daviddm-url]: https://david-dm.org/Fannon/semlog

package/docs/attributes.adoc

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

package/eslint.config.js

@@ -0,0 +1,31 @@
+'use strict';
+
+const js = require('@eslint/js');
+const globals = require('globals');
+const prettier = require('eslint-config-prettier');
+
+module.exports = [
+    js.configs.recommended,
+    {
+        languageOptions: {
+            globals: globals.node,
+            ecmaVersion: 2022,
+        },
+        rules: {
+            'no-unused-vars': ['warn', { argsIgnorePattern: '^_' }],
+            'no-console': 'off',
+            'no-var': 'error',
+            'prefer-const': 'error',
+        },
+    },
+    {
+        files: ['test/**/*.js'],
+        languageOptions: {
+            globals: {
+                ...globals.node,
+                ...globals.mocha,
+            },
+        },
+    },
+    prettier,
+];