feat!: report what a text should be refused for, move to TypeScript, ESM, vite and vitest

.github/workflows/ci.yml

@@ -0,0 +1,67 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - name: Use Node.js 24
+        uses: actions/setup-node@v6
+        with:
+          node-version: 24
+          cache: "yarn"
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+      - name: Lint
+        run: yarn lint
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - name: Use Node.js 24
+        uses: actions/setup-node@v6
+        with:
+          node-version: 24
+          cache: "yarn"
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+      - name: Check types
+        run: yarn check-build
+      - name: Build
+        run: yarn build
+      - name: Load the package both ways
+        run: |
+          node --input-type=module -e "import CensorifyIt from 'censorify-it'; new CensorifyIt().forbidden('evil.cfd/a/x')"
+          node -e "const { default: CensorifyIt } = require('censorify-it'); new CensorifyIt().forbidden('evil.cfd/a/x')"
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - name: Use Node.js 24
+        uses: actions/setup-node@v6
+        with:
+          node-version: 24
+          cache: "yarn"
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+      - name: Test with coverage
+        run: yarn coverage
+        env:
+          CI: true
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v7
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          report_type: coverage
+      - name: Upload test results to Codecov
+        if: ${{ !cancelled() }}
+        uses: codecov/codecov-action@v7
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          report_type: test_results

.gitignore

@@ -1,13 +1,17 @@
 # dependencies
 /node_modules
 
+# build and test outputs
+/dist
+/coverage
+coverage.lcov
+test-report.junit.xml
+.eslintcache
+*.tsbuildinfo
+
 # misc
 .DS_Store
 
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
-
-dist/*
-
-.eslintcache

.husky/commit-msg

@@ -0,0 +1 @@
+npx commitlint --edit

.husky/pre-commit

@@ -0,0 +1 @@
+npx lint-staged --allow-empty $1

README.md

@@ -14,6 +14,13 @@ Built as an extension of [LinkifyIt](https://github.com/markdown-it/linkify-it)
 yarn add censorify-it
 ```
 
+The package is written in TypeScript and ships its types. It is an ES module, with a CommonJS build:
+
+```js
+import CensorifyIt from 'censorify-it' // or: import { CensorifyIt } from 'censorify-it'
+const { CensorifyIt } = require('censorify-it')
+```
+
 ## Usage
 
 ```js
@@ -110,4 +117,48 @@ console.log(censorify.match('Check out github.com or mysite.com or even example.
 // ]
 ```
 
+Every match has a `type`: `link`, `email` or `phone`. Exceptions can be given by type, which is safer than a single
+list: a loose phone number pattern in a single list also lets through the links holding these digits.
+
+```js
+censorify.set({
+  exceptions: {
+    link: [/^(?:https?:\/\/)?(?:[\w-]+\.)*mysite\.com(?=[/?#]|$)/i],
+    phone: [/\+33.?1.?23.?45.?67.?89/],
+  },
+})
+```
+
+## Refusing a text instead of censoring it
+
+Censoring can afford false positives: a date taken for a phone number only costs a few stars. Refusing a text
+cannot. `forbidden` only reports what is a link or a phone number beyond doubt, exceptions applied:
+
+- links: `scheme://`, `www.`, `domain/path` or `domain?query`, whatever the TLD. A bare domain is not reported,
+  it would also catch a missing space after a period (`see you soon.In any case`);
+- phone numbers: international ones (`+…`, `00…`) from 8 digits, national ones from 9 digits. Dates and lists of
+  small numbers (`12 15 20 25 30 people`) are left aside.
+
+```js
+const censorify = new CensorifyIt()
+
+console.log(censorify.forbidden('Go to evil.cfd/a/x or call 06 12 34 56 78, we are 12 on 2026-11-20'))
+// [
+//   Match { schema: '', type: 'link', index: 6, lastIndex: 18, raw: 'evil.cfd/a/x', url: 'http://evil.cfd/a/x', text: 'evil.cfd/a/x' },
+//   Match { schema: '', type: 'phone', index: 27, lastIndex: 41, raw: '06 12 34 56 78', url: '06 12 34 56 78', text: '06 12 34 56 78' }
+// ]
+```
+
+Everything `forbidden` reports is censored by `process` as well.
+
 All the other settings and additions as defined by [LinkifyIt](https://github.com/markdown-it/linkify-it/blob/master/README.md#api) also apply.
+
+## Development
+
+```
+yarn test        # vitest, in watch mode
+yarn coverage    # one run, with coverage
+yarn lint
+yarn check-build # type check
+yarn build       # vite, to dist/
+```

commitlint.config.js

@@ -0,0 +1,3 @@
+export default {
+  extends: ['@eatwith/commitlint-config-conventional'],
+}

eslint.config.js

@@ -0,0 +1,32 @@
+import { defineConfig, globalIgnores } from 'eslint/config'
+import globals from 'globals'
+import { typescript } from 'eslint-config-vizeat'
+
+export default defineConfig(
+  globalIgnores([
+    'node_modules',
+    'dist',
+    'coverage',
+    'lint-staged.config.js',
+    'vite.config.ts',
+    'commitlint.config.js',
+  ]),
+  typescript,
+  {
+    languageOptions: {
+      sourceType: 'module',
+      globals: {
+        ...globals.node,
+        ...globals.browser,
+        ...globals.vitest,
+      },
+      parserOptions: {
+        project: './tsconfig.eslint.json',
+      },
+    },
+    files: ['src/**/*.ts'],
+    rules: {
+      '@typescript-eslint/explicit-function-return-type': 'off',
+    },
+  },
+)

lint-staged.config.js

@@ -0,0 +1,4 @@
+export default {
+  '**/*.{js,ts}': 'eslint --fix',
+  '**/*.{js,ts}?(x)': () => 'yarn check-build',
+}