{"id":19270222,"url":"https://github.com/rambler-digital-solutions/licenselint","last_synced_at":"2025-02-23T20:14:22.269Z","repository":{"id":65253671,"uuid":"587814603","full_name":"rambler-digital-solutions/licenselint","owner":"rambler-digital-solutions","description":"A linter for NPM package licenses to avoid dependencies that not compatible with license of your software","archived":false,"fork":false,"pushed_at":"2024-02-20T08:27:19.000Z","size":860,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-02-18T10:02:21.350Z","etag":null,"topics":["license","license-checking","licenselint","lint"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rambler-digital-solutions.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-01-11T16:45:10.000Z","updated_at":"2024-08-12T10:47:19.000Z","dependencies_parsed_at":"2024-09-26T10:51:00.722Z","dependency_job_id":null,"html_url":"https://github.com/rambler-digital-solutions/licenselint","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rambler-digital-solutions%2Flicenselint","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rambler-digital-solutions%2Flicenselint/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rambler-digital-solutions%2Flicenselint/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rambler-digital-solutions%2Flicenselint/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rambler-digital-solutions","download_url":"https://codeload.github.com/rambler-digital-solutions/licenselint/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240371758,"owners_count":19790888,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["license","license-checking","licenselint","lint"],"created_at":"2024-11-09T20:23:49.411Z","updated_at":"2025-02-23T20:14:22.237Z","avatar_url":"https://github.com/rambler-digital-solutions.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# License Lint\n\nA linter for NPM package licenses to avoid dependencies that not compatible with license of your software. It can check licenses automatically on CI or on NPM `postinstall`.\n\n![](./screenshot.png)\n\n## Install\n\n```sh\nnpm install -D @rambler-tech/licenselint\n```\n\nor \n\n```sh\nyarn add -D @rambler-tech/licenselint\n```\n\n## Usage\n\n```sh\nlicenselint --help\n\n  Lint NPM package licenses\n\n  Usage\n    licenselint [dirname]\n\n  Options\n    --production    Only lint production dependencies\n    --development   Only lint development dependencies\n    --summary       Output a summary of the license usage\n    --deny          Fail on an occurrence of the licenses of the deny list\n    --allow         Fail on an occurrence of the licenses not in the allow list\n    --exclude       Exclude modules which licenses are in the list\n    --extends       Use custom configuration file\n\n  Examples\n    licenselint\n    licenselint packages/foo\n    licenselint --production\n    licenselint --deny LGPL\n    licenselint --allow MIT --allow ISC\n    licenselint --extends shared/licenserc.json\n```\n\nThen use it for automatically check in CI\n\n```yaml\n...\nlint deps:\n  stage: test\n  script:\n    - npm install\n    - licenselint\n...\n```\n\nOr on NPM `postinstall`\n\n```json\n{\n  \"name\": \"app\",\n  \"description\": \"...\",\n  \"version\": \"0.1.2\",\n  \"scripts\": {\n    \"...\": \"...\",\n    \"postinstall\": \"licenselint\"\n  },\n  \"...\": \"...\"\n}\n```\n\n## Configuration\n\nCreate `.licenserc.json` configuration file:\n\n```json\n{\n  \"production\": true,\n  \"deny\": [\n    \"GPL\",\n    \"LGPL\"\n  ]\n}\n```\n\nConfiguration file supports all CLI flags.\n\nAlso you can extends your local setup with shared configuration:\n\n```json\n{\n  \"extends\": \"@shared/licenserc\",\n  \"summary\": true\n}\n```\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frambler-digital-solutions%2Flicenselint","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frambler-digital-solutions%2Flicenselint","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frambler-digital-solutions%2Flicenselint/lists"}