idnits v3

.editorconfig

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

.eslintrc.cjs

@@ -0,0 +1,15 @@
+module.exports = {
+  env: {
+    browser: true,
+    es2021: true
+  },
+  extends: 'standard',
+  overrides: [
+  ],
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module'
+  },
+  rules: {
+  }
+}

.github/ISSUE_TEMPLATE/new-issue-for-idnits2.md

@@ -0,0 +1,10 @@
+---
+name: New Issue for idnits2
+about: Shell-based CLI
+title: ''
+labels: 'component: idnits2'
+assignees: ''
+
+---
+
+

.github/ISSUE_TEMPLATE/new-issue-for-idnits3.md

@@ -0,0 +1,10 @@
+---
+name: New Issue for idnits3
+about: Javascript-based CLI / Library
+title: ''
+labels: 'component: idnits3'
+assignees: ''
+
+---
+
+

.github/workflows/publish.yml

@@ -0,0 +1,41 @@
+name: Publish to NPM
+
+on:
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set Build Variables
+        run: |
+          echo "NEXT_VERSION=3.0.0-alpha.${GITHUB_RUN_NUMBER}" >> $GITHUB_ENV
+      - name: Setup Node.js environment
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18.x
+          registry-url: https://registry.npmjs.org/
+
+      - name: Set package.json version
+        uses: HarmvZ/[email protected]
+        with:
+          version: ${{ env.NEXT_VERSION }}
+
+      - name: Install NPM Dependencies
+        run: npm ci
+
+      - name: Run Tests
+        run: npm test
+
+      - name: Publish to NPM
+        run: npm publish --access public --provenance
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

.gitignore

@@ -0,0 +1,63 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+dist

.npmrc

@@ -0,0 +1,4 @@
+save-exact = true
+save-prefix = ""
+fund = false
+audit = false

LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2023, The IETF Trust
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -1,6 +1,82 @@
-This is the active repository for idnits.
+<div align="center">
+
+<img src="https://raw.githubusercontent.com/ietf-tools/common/main/assets/logos/idnits.svg" alt="IDNITS" height="125" />
+
+[![npm](https://img.shields.io/npm/v/@ietf-tools/idnits)](https://www.npmjs.com/package/@ietf-tools/idnits)
+[![node-current](https://img.shields.io/node/v/@ietf-tools/idnits)](https://github.com/ietf-tools/idnits)
+[![License](https://img.shields.io/github/license/ietf-tools/idnits)](https://github.com/ietf-tools/idnits/blob/v3/LICENSE)
+
+##### Library / CLI to inspect Internet-Draft documents for a variety of conditions to conform with IETF policies.
+
+</div>
 
-**Note that the repository has been renamed from idnits-mirror to idnits**
+> ⚠️ *This branch is for the new JS-based idnits3. For the older shell-based idnits2, [view the v2 branch](https://github.com/ietf-tools/idnits/tree/v2) isntead.*
 
-This project began as a snapshot mirror of idnits-2.17 from https://tools.ietf.org/tools/idnits/.
+- [Installation](#installation)
+- [Usage](#usage)
+  - [As a CLI](#as-a-cli)
+  - [As a library](#as-a-library)
+- [Tests](#tests)
+- [Development](#development)
+- [Contributing](https://github.com/ietf-tools/.github/blob/main/CONTRIBUTING.md)
 
+---
+
+### Installation
+
+1. Install [Node.js 18.x or later](https://nodejs.org/)
+2. Install **idnits**:
+
+```sh
+npm install -g @ietf-tools/idnits
+```
+
+> You can also run idnits directly without installing it globally using `npx @ietf-tools/idnits <args>`
+
+### Usage
+
+#### As a CLI
+
+```sh
+idnits [args] <file path>
+```
+
+| Arguments | Alias | Description | Default |
+|---|---|---|---|
+| `--filter` | `-f` | Filter output to only certain severity types. Can be declared multiple times to filter multiple severity types.<br>Accepted values: `errors`, `warnings`, `comments` |  |
+| `--mode` | `-m` | Validation mode, must be either `normal`, `forgive-checklist` or `submission`<br>Accepted shorthands: `norm`, `n`, `f-c`, `fc`, `f`, `sub`, `s` | `normal` |
+| `--no-progress` |  | Disable progress messages / animations in `pretty` output.<br>No effect in other output formats. |  |
+| `--offline` |  | Disable validations that require an internet connection. |  |
+| `--output` | `-o` | Output format, must be either `pretty`, `json` or `count` | `pretty` |
+| `--solarized` |  | Use alternate colors for a solarized light theme terminal.<br>Only used with the `pretty` output format. |  |
+| `--year` | `-y` | Expect the given year in the boilerplate |  |
+| `--help` | `-h` | Print the help text and exit |  |
+| `--version` |  | Print the version and exit |  |
+
+#### As a library
+
+> *coming soon*
+
+### Tests
+
+Tests are made using the [Jest](https://jestjs.io/) library and are located under the `tests` directory.
+
+You can run the suite of tests using:
+```sh
+# Make sure you installed dependencies first:
+npm install
+
+# Run the tests
+npm test
+```
+
+Code coverage is expected to reach 100%. Ensure this is still the case when making edits / adding new functionality.
+
+### Development
+
+1. Clone the project
+2. Run `npm install`
+3. Run the CLI: *(replacing `<args>` and `<file path>` with the desired flags + file path)*
+    ```
+    node cli.js <args> <file path>
+    ```