repositoryDirectoryValidity

Enforce that repository.directory matches the package.json file directory.

✅ This rule is included in the package-json logicalpresets.

The repository.directory property should point to the location of the package’s root within its repository (the directory containing its package.json). This rule reports repository.directory string values that do not match the package’s current directory, relative to the repo root.

Examples

For a package.json file in packages/example:

❌ Incorrect

{
  "repository": {
    "type": "git",
    "url": "https://github.com/flint-fyi/flint",
    "directory": "something-else"
  }
}

✅ Correct

{
  "repository": {
    "type": "git",
    "url": "https://github.com/flint-fyi/flint",
    "directory": "packages/example"
  }
}

When Not To Use It

If package manifests are generated into a different directory from their source package metadata, repository.directory might intentionally point somewhere other than the generated package.json file. In that case this rule may not be for you.

Further Reading

• npm: package.json > repository

Equivalents in Other Linters

• ESLint: package-json/valid-repository-directory