scrutinizer
    TypeScript icon, indicating that this package has built-in type declarations

    5.0.0 • Public • Published

    scrutinizer

    npm npm license npm downloads travis

    Extract a git repository's metadata relying on open source conventions

    Installation

    Install scrutinizer by running:

    npm install --save scrutinizer

    Documentation

    scrutinizer.local(gitRepository, options) ⇒ Promise

    Kind: static method of scrutinizer
    Summary: Examine a local git repository directory
    Access: public
    Fulfil: Object - examination results

    Param Type Description
    gitRepository String path to git repository
    options Object options
    options.reference String git reference to check
    [options.progress] function progress callback (state)
    [options.whitelistPlugins] Array.<String> list of plugins to run. Matches all if empty

    Example

    scrutinizer.local('./foo/bar/baz', {
      reference: 'master',
      progress: (state) => {
        console.log(state.percentage)
      }
    }).then((results) => {
      console.log(results)
    })

    scrutinizer.remote(gitRepository, options) ⇒ Promise

    If $GITHUB_TOKEN is set, it will be used to authenticate with GitHub to increase rate-limiting.

    Kind: static method of scrutinizer
    Summary: Examine a remote git repository url
    Access: public
    Fulfil: Object - examination results

    Param Type Description
    gitRepository String git repository url
    options Object options
    options.reference String git reference to check
    [options.progress] function progress callback (state)
    [options.whitelistPlugins] Array.<String> list of plugins to run. Matches all if empty

    Example

    scrutinizer.remote('git@github.com:foo/bar.git', {
      reference: 'master',
      progress: (state) => {
        console.log(state.percentage)
      }
    }).then((results) => {
      console.log(results)
    })

    Tests

    Our test suite contains integration test cases that run this module against real projects. For that reason, we maintain a set of git submodules in test/repositories, where the actual test cases that assert their results live in test/e2e.

    1. Fetch all git submodules
    git submodule update --init --recursive
    1. Set $GITHUB_TOKEN, to increase rate-limiting

    2. Run the test npm script:

    npm test

    You may enable debug information by setting DEBUG=scrutinizer*.

    Contribute

    Before submitting a PR, please make sure that you include tests, and that the linter runs without any warning:

    npm run lint

    One of the most valuable things you can contribute to this project is implement or improve plugins, which are small functions whose duty is to extract a certain facet about the repository, like license information.

    1. Create a new file in lib/plugins, like myplugin.js

    2. Export a function that takes a single argument, backend, which contains every function you need to interact with a git repository, like reading a file

    Make sure you use the backend object instead of falling back to fs or an API call, so the plugin works fine in both local and remote modes.

    You can do whatever you need here, including checking out other branches. scrutinizer will make sure the project is properly reset before calling another plugin.

    1. Add the new plugin to BUILTIN_PLUGINS in lib/index.js

    2. Update test cases in test/e2e

    Support

    If you're having any problem, please raise an issue on GitHub.

    License

    This project is free software, and may be redistributed under the terms specified in the license.

    Keywords

    none

    Install

    npm i scrutinizer

    DownloadsWeekly Downloads

    2,028

    Version

    5.0.0

    License

    Apache-2.0

    Unpacked Size

    196 kB

    Total Files

    128

    Last publish

    Collaborators

    • balena.io