Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/balena-io-modules/scrutinizer
Extract a git repository's metadata relying on open source conventions
https://github.com/balena-io-modules/scrutinizer
git github github-api
Last synced: about 2 months ago
JSON representation
Extract a git repository's metadata relying on open source conventions
- Host: GitHub
- URL: https://github.com/balena-io-modules/scrutinizer
- Owner: balena-io-modules
- License: apache-2.0
- Archived: true
- Created: 2018-01-17T15:47:04.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-09-12T11:55:41.000Z (over 2 years ago)
- Last Synced: 2024-04-14T10:15:33.570Z (9 months ago)
- Topics: git, github, github-api
- Language: TypeScript
- Size: 1.25 MB
- Stars: 8
- Watchers: 3
- Forks: 0
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
scrutinizer
===========
[](https://npmjs.com/package/scrutinizer)
[](https://npmjs.com/package/scrutinizer)
[](https://npmjs.com/package/scrutinizer)
[](https://travis-ci.org/resin-io-modules/scrutinizer)
> Extract a git repository's metadata relying on open source
> conventions
Installation
------------
Install `scrutinizer` by running:
```sh
npm install --save scrutinizer
```
Documentation
-------------
* [scrutinizer](#module_scrutinizer)
* [.local(gitRepository, options)](#module_scrutinizer.local) ⇒ Promise
* [.remote(gitRepository, options)](#module_scrutinizer.remote) ⇒ Promise
### scrutinizer.local(gitRepository, options) ⇒ Promise
**Kind**: static method of [scrutinizer](#module_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**
```js
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](#module_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**
```js
scrutinizer.remote('[email protected]: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
```sh
git submodule update --init --recursive
```
2. Set `$GITHUB_TOKEN`, to increase rate-limiting
3. Run the `test` npm script:
```sh
npm test
```
You may enable debug information by setting `DEBUG=scrutinizer*`.
Contribute
----------
- Issue Tracker: [github.com/resin-io-modules/scrutinizer/issues](https://github.com/resin-io-modules/scrutinizer/issues)
- Source Code: [github.com/resin-io-modules/scrutinizer](https://github.com/resin-io-modules/scrutinizer)
Before submitting a PR, please make sure that you include tests, and that the
linter runs without any warning:
```sh
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.
3. Add the new plugin to `BUILTIN_PLUGINS` in `lib/index.js`
4. Update test cases in `test/e2e`
Support
-------
If you're having any problem, please [raise an issue][newissue] on GitHub.
License
-------
This project is free software, and may be redistributed under the terms
specified in the [license].
[newissue]: https://github.com/resin-io-modules/scrutinizer/issues/new
[license]: https://github.com/resin-io-modules/scrutinizer/blob/master/LICENSE