@slimio/psp/src/requiredElems.json

Analyze compliance with the structural policy of a SlimIO project

{
    "EXCLUDE_DIRS": [
        "node_modules",
        "test",
        "tests",
        "coverage",
        "example",
        ".vscode",
        ".nyc_output",
        "docs",
        "jsdoc",
        "benchmark",
        ".git"
    ],
    "EXCLUDE_FILES": [
        "LICENSE",
        "license"
    ],
    "FILE_TO_CHECKS": [
        "package.json",
        ".eslintrc",
        ".eslintignore",
        ".editorconfig",
        "index.d.ts",
        "jsdoc.json",
        "commitlint.config.js",
        "LICENSE",
        ".npmignore",
        "README.md",
        ".npmrc",
        ".gitignore",
        ".travis.yml",
        "binding.gyp"
    ],
    "README_TITLES": [
        "## Requirements",
        "## Getting Started",
        "## API",
        "## License",
        "## Dependencies"
    ],
    "REQUIRE_DIR": [
        [
            "src",
            "test",
            "benchmark",
            "docs"
        ],
        [
            "src",
            "benchmark"
        ]
    ],
    "PKG_DEP": {
        "napi": [
            "node-addon-api",
            "node-gyp-build"
        ],
        "addon": [
            "@slimio/addon",
            "@slimio/scheduler"
        ]
    },
    "PKG_DEVDEP": [
        "@slimio/eslint-config",
        "eslint",
        "@commitlint/cli",
        "@commitlint/config-conventional",
        "husky"
    ],
    "PKG_OTHERS": [
        "keywords",
        "author",
        "license",
        "description",
        "engines",
        "husky"
    ],
    "PKG_SCRIPTS": {
        "package": [
            ["test", null],
            ["doc", "jsdoc -c ./jsdoc.json -r -R ./README.md -P ./package.json --verbose"],
            ["coverage", "codecov"],
            ["report", "nyc report --reporter=html"],
            ["prepublishOnly", "pkg-ok"]
        ],
        "cli": [
            ["doc", "jsdoc -c ./jsdoc.json -r -R ./README.md -P ./package.json --verbose"],
            ["prepublishOnly", "pkg-ok"]
        ],
        "napi": [
            ["prebuilds", "prebuildify --napi"],
            ["build", "cross-env node-gyp configure && node-gyp build"],
            ["test", null],
            ["doc", "jsdoc -c ./jsdoc.json -r -R ./README.md -P ./package.json --verbose"],
            ["coverage", "codecov"],
            ["report", "nyc report --reporter=html"],
            ["prepublishOnly", "pkg-ok"]
        ],
        "addon": [
            ["test", null],
            ["doc", "jsdoc -c ./jsdoc.json -r -R ./README.md -P ./package.json --verbose"]
        ]
    },
    "PROJECT_TYPE": [
        "cli",
        "napi",
        "addon",
        "package"
    ],
    "MD_BADGES": [
        "version",
        "maintenance",
        "mit",
        "dep",
        "size",
        "known vulnerabilities",
        "build status"
    ]
}