feat: Implement shareable package-json-lint config.

.eslintrc.json

@@ -0,0 +1,3 @@
+{
+ "extends": "es/node"
+}

.github/CODEOWNERS

@@ -0,0 +1 @@
+* @goloroden @yeldiRium

.github/dependabot.yml

@@ -0,0 +1,20 @@
+version: 2
+updates:
+- package-ecosystem: npm
+ directory: "/"
+ schedule:
+ interval: weekly
+ open-pull-requests-limit: 10
+ assignees:
+ - dotKuro
+ - goloroden
+ - strangedev
+ - yeldiRium
+ labels:
+ - Dependencies
+ versioning-strategy: increase
+ allow:
+ - dependency-type: direct
+ commit-message:
+ prefix: fix
+ prefix-development: chore

.github/workflows/qa.yml

@@ -0,0 +1,26 @@
+name: QA
+
+on: pull_request
+
+jobs:
+ qa:
+ name: QA
+ runs-on: ${{ matrix.os }}
+
+ strategy:
+ matrix:
+ node-version: [ '16.x' ]
+ os: [ ubuntu-latest, macos-latest ]
+
+ steps:
+ - uses: actions/checkout@v1
+ - name: Use Node.js ${{ matrix.node-version }}
+ uses: actions/setup-node@v1
+ with:
+ node-version: ${{ matrix.node-version }}
+ - name: Install dependencies
+ run: |
+ npm install
+ - name: Run roboter
+ run: |
+ npx roboter

.github/workflows/release.yml

@@ -0,0 +1,29 @@
+name: Release
+
+on:
+ push:
+ branches:
+ - 'main'
+
+jobs:
+ release:
+ name: Release
+ runs-on: ubuntu-latest
+
+ steps:
+ - uses: actions/checkout@v1
+ - name: Use Node.js
+ uses: actions/setup-node@v1
+ with:
+ node-version: 16.x
+ - name: Install dependencies
+ run: |
+ npm install
+ - name: Run roboter
+ run: |
+ npx roboter
+ - name: Release
+ env:
+ GITHUB_TOKEN: ${{ secrets.GH_TOKEN_ADMIN }}
+ NPM_TOKEN: ${{ secrets.NPM_TOKEN_ADMIN }}
+ run: npx semantic-release

.gitignore

@@ -0,0 +1,10 @@
+# Node.js folders
+*coverage/
+*node_modules/
+
+# Build artefacts
+*build/
+
+# OS generated files and folders
+.DS_Store
+npm-debug.log

.npmignore

@@ -0,0 +1,3 @@
+.dependabot
+.github
+test

.npmpackagejsonlintrc.json

@@ -0,0 +1,6 @@
+{
+ "extends": "./lib.json",
+ "rules": {
+ "require-types": "off"
+ }
+}

.releaserc.json

@@ -0,0 +1,3 @@
+{
+ "extends": "semantic-release-configuration"
+}

LICENSE.txt

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) 2021 the native web.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,44 @@
+# npm-package-json-lint-config-tnw
+
+npm-package-json-lint-config-tnw contains a strict package-json-lint configuration for apps and libraries.
+
+## Status
+
+| Category | Status |
+| ---------------- | ------------------------------------------------------------------------------------------------------------- |
+| Version | [![npm](https://img.shields.io/npm/v/npm-package-json-lint-config-tnw)](https://www.npmjs.com/package/npm-package-json-lint-config-tnw) |
+| Dependencies | ![David](https://img.shields.io/david/thenativeweb/npm-package-json-lint-config-tnw) |
+| Dev dependencies | ![David](https://img.shields.io/david/dev/thenativeweb/npm-package-json-lint-config-tnw) |
+| Build | ![GitHub Actions](https://github.com/thenativeweb/npm-package-json-lint-config-tnw/workflows/Release/badge.svg?branch=master) |
+| License | ![GitHub](https://img.shields.io/github/license/thenativeweb/npm-package-json-lint-config-tnw) |
+
+## Installation
+
+```shell
+$ npm install npm-package-json-lint-config-tnw \
+ npm-package-json-lint
+```
+
+## Quick Start
+
+This module contains a very strict package-json-lint configuration, one for apps and one for libraries. It aims to eradicate _any_ variation in your `package.json` files. It intends to make your package manifests look uniform, enforce that certain fields exist and prevent you from accidentally installing non-strict dependencies. This helps you to narrow down your focus to pure content, as you do not have to think about the order of fields or which fields you need any more. There is very little difference between the config variant for apps and the one for libraries; The difference is mainly that libraries expose an entry point for code imports, while apps expose an executable.
+
+To use one of those configurations, create a `.npmpackagejsonlintrc.json` file in your project and use the `extends` keyword:
+
+```json
+{
+ "extends": "npm-package-json-lint-config-tnw/lib"
+}
+```
+
+Alternatively, you may also use `npm-package-json-lint-config-tnw/app`.
+
+If you want to override any rules, you can do so in your configuration file.
+
+## Running quality assurance
+
+To run quality assurance for this module use [roboter](https://www.npmjs.com/package/roboter):
+
+```shell
+$ npx roboter
+```

app.json

@@ -0,0 +1,6 @@
+{
+ "extends": "./base.json",
+ "rules": {
+ "require-bin": "error"
+ }
+}

base.json

@@ -0,0 +1,143 @@
+{
+ "rules": {
+ "require-author": "off",
+ "require-bin": "off",
+ "require-bugs": "off",
+ "require-bundledDependencies": "off",
+ "require-config": "off",
+ "require-contributors": "error",
+ "require-cpu": "off",
+ "require-dependencies": "error",
+ "require-description": "error",
+ "require-devDependencies": "error",
+ "require-directories": "off",
+ "require-engines": "error",
+ "require-files": "off",
+ "require-funding": "off",
+ "require-homepage": "off",
+ "require-keywords": "error",
+ "require-license": "error",
+ "require-main": "off",
+ "require-man": "off",
+ "require-module": "off",
+ "require-name": "error",
+ "require-optionalDependencies": "off",
+ "require-os": "off",
+ "require-peerDependencies": "off",
+ "require-preferGlobal": "off",
+ "require-private": "error",
+ "require-publishConfig": "off",
+ "require-repository-directory": "off",
+ "require-repository": "error",
+ "require-scripts": "error",
+ "require-types": "off",
+ "require-typings": "off",
+ "require-version": "error",
+
+ "bin-type": "error",
+ "bundledDependencies-type": "error",
+ "config-type": "error",
+ "cpu-type": "error",
+ "dependencies-type": "error",
+ "description-type": "error",
+ "devDependencies-type": "error",
+ "directories-type": "error",
+ "engines-type": "error",
+ "files-type": "error",
+ "homepage-type": "error",
+ "keywords-type": "error",
+ "license-type": "error",
+ "main-type": "error",
+ "man-type": "error",
+ "name-type": "error",
+ "optionalDependencies-type": "error",
+ "os-type": "error",
+ "peerDependencies-type": "error",
+ "preferGlobal-type": "error",
+ "private-type": "error",
+ "repository-type": "error",
+ "scripts-type": "error",
+ "version-type": "error",
+
+ "valid-values-author": "off",
+ "valid-values-engines": "off",
+ "valid-values-license": [ "error", [ "MIT" ]],
+ "valid-values-name-scope": "off",
+ "valid-values-private": "off",
+ "valid-values-publishConfig": "off",
+
+ "no-repeated-dependencies": "error",
+
+ "no-absolute-version-dependencies": "off",
+ "no-archive-dependencies": "error",
+ "no-caret-version-dependencies": "error",
+ "no-file-dependencies": "error",
+ "no-git-dependencies": "error",
+ "no-restricted-dependencies": "off",
+ "no-restricted-pre-release-dependencies": "off",
+ "no-tilde-version-dependencies": "error",
+ "prefer-absolute-version-dependencies": "error",
+ "prefer-alphabetical-dependencies": "error",
+ "prefer-caret-version-dependencies": "off",
+ "prefer-no-version-zero-dependencies": "off",
+ "prefer-tilde-version-dependencies": "off",
+
+ "no-absolute-version-devDependencies": "off",
+ "no-archive-devDependencies": "error",
+ "no-caret-version-devDependencies": "error",
+ "no-file-devDependencies": "error",
+ "no-git-devDependencies": "error",
+ "no-restricted-devDependencies": "off",
+ "no-restricted-pre-release-devDependencies": "off",
+ "no-tilde-version-devDependencies": "error",
+ "prefer-absolute-version-devDependencies": "error",
+ "prefer-alphabetical-devDependencies": "error",
+ "prefer-caret-version-devDependencies": "off",
+ "prefer-no-version-zero-devDependencies": "off",
+ "prefer-tilde-version-devDependencies": "off",
+
+ "prefer-alphabetical-bundledDependencies": "error",
+
+ "prefer-alphabetical-optionalDependencies": "error",
+
+ "prefer-alphabetical-peerDependencies": "error",
+
+ "prefer-alphabetical-scripts": "error",
+ "prefer-scripts": "off",
+
+ "description-format": [ "error", {
+ "requireEndingPeriod": true
+ }],
+ "name-format": "error",
+ "version-format": "error",
+
+ "prefer-property-order": [ "error", [
+ "name",
+ "version",
+ "description",
+ "contributors",
+ "private",
+ "main",
+ "module",
+ "types",
+ "type",
+ "bin",
+ "engines",
+ "dependencies",
+ "devDependencies",
+ "peerDependencies",
+ "scripts",
+ "repository",
+ "publishConfig",
+ "keywords",
+ "license"
+ ]],
+ "no-duplicate-properties": "error",
+
+ "prefer-no-engineStrict": "error",
+ "prefer-no-dependencies": "off",
+ "prefer-no-devDependencies": "off",
+ "prefer-no-optionalDependencies": "error",
+ "prefer-no-peerDependencies": "off"
+ }
+}

lib.json

@@ -0,0 +1,7 @@
+{
+ "extends": "./base.json",
+ "rules": {
+ "require-main": "error",
+ "require-types": "error"
+ }
+}