Skip to content

Latest commit

 

History

History
80 lines (64 loc) · 1.35 KB

ts-package-json-files-required.md

File metadata and controls

80 lines (64 loc) · 1.35 KB

ts-package-json-files-required

Requires files in package.json to contain paths to the package contents.

Specifically, this rule looks for inclusion of dist, dist-esm/src, and src as either just those directories or specific subdirectories

This rule is fixable using the --fix option.

Examples

Good

{
    "files": [
        "dist",
        "dist-esm/src"
        "src"
    ]
}
{
    "files": [
        "./dist",
        "./dist-esm/src"
        "./src"
    ]
}
{
    "files": [
        "dist/",
        "dist-esm/src/"
        "src/"
    ]
}
{
    "files": [
        "dist/lib",
        "dist-esm/src/lib"
        "src/lib"
    ]
}

Bad

{
  "files": ["dist", "dist-esm/src"]
}
{
  "files": ["dist"]
}
{
  "files": []
}
{}

Also encompasses ts-include-cjs, ts-include-esm, and ts-include-original-source , as the rules are similar enough to not exist separately for linting purposes.