Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/bigfootds/npm-compliance-helper

Tool to help generate legal & copyright notices about project dependencies.

https://github.com/bigfootds/npm-compliance-helper

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Committers with academic emails
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.8%) to scientific vocabulary

Keywords

cli continous-compliance documentation licence license npm
Last synced: 5 months ago · JSON representation

Repository

Tool to help generate legal & copyright notices about project dependencies.

Basic Info
Statistics
  • Stars: 1
  • Watchers: 0
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
cli continous-compliance documentation licence license npm
Created almost 2 years ago · Last pushed almost 2 years ago
Metadata Files
Readme Funding License

README.md

@bigfootds/npm-compliance-helper

Tool to help generate legal & copyright notices about project dependencies.

Intended usage is to provide data in an organized way for a front-end to then display.

Legal Disclaimer

This tool should not be used blindly or without further human activity to process its output.

Don't come blaming us for your poor business decisions.

Installation

This package can be used as a dependency, with its functions imported into your dev or production or other code.

Or, this package can be used as a command line tool.

To install in your production dependencies, run this:

bash npm install @bigfootds/npm-compliance-helper

To install in your dev dependencies, run this:

bash npm install --save-dev @bigfootds/npm-compliance-helper

To run as a command line tool without installing it into a project, run this:

npx @bigfootds/npm-compliance-helper

Basic Usage

Default usage of this package will meet most peoples' needs.

Default usage will search for the package.json file in the current working directory and create license data based on that file.

Command Line Usage

If using this package as a command line tool, you can pass in customisation options with these flags:

``bash -p, --packageJsonPath <packageJsonPath> A path to a package.json. If not provided, the package.json in the current working directory will be used. (default: Result ofpath.join(process.cwd(), "package.json")` ) -lo, --licenseOverrides The licenses you want to allow in your project. (default: []) -ex, --excludedLicenses The licenses you want to forbid in your project. (default: []) -h, --help display help for command

```

Please note that the license overrides and license exclusions are not yet implemented as of 4th May 2024.

Typical usage of this command may look like:

bash npx @bigfootds/npm-compliance-helper > ./out/organizedLicenseData.json

You could even create a bit of robust NPM/bash scripting like so, to guarantee that the out folder exists:

bash mkdir -p ./out && npx @bigfootds/npm-compliance-helper > ./out/organizedLicenseData.json

Imported Package Usage

If you wish to use this package within your own JavaScript code, you can import the package like so:

js const {organiseProjectLicenseInfo} = require("@bigfootds/npm-compliance-helper");

You can provide that function with a custom path to a package.json file, or just give it nothing and it will find the package.json file in the current working directory.

Like so:

```js async function someFunction(){ let output = "";

output = await organiseProjectLicenseInfo().catch(error => error);

console.log(Object.keys(output));

console.log(output.directDependencies);

return output;

} ```

Owner

  • Name: BigfootDS
  • Login: BigfootDS
  • Kind: organization
  • Email: contact@bigfootds.com
  • Location: Sydney, AUS

Game development group.

GitHub Events

Total
Last Year

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 4
  • Total Committers: 1
  • Avg Commits per committer: 4.0
  • Development Distribution Score (DDS): 0.0
Past Year
  • Commits: 0
  • Committers: 0
  • Avg Commits per committer: 0.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Alex a****r@b****m 4
Committer Domains (Top 20 + Academic)
bigfootds.com: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: less than a minute
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
Pull Request Authors
  • AlexStormwood (1)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 1
  • Total maintainers: 1
npmjs.org: @bigfootds/npm-compliance-helper

Tool to help generate legal & copyright notices about project dependencies.

  • Versions: 1
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 0 Last month
Rankings
Dependent repos count: 30.0%
Average: 36.4%
Dependent packages count: 42.9%
Maintainers (1)
alexstormwood
Funding
  • type: github
  • url: https://github.com/sponsors/BigfootDS
Last synced: 6 months ago