Skip to content

Latest commit

 

History

History
118 lines (76 loc) · 4.3 KB

README.md

File metadata and controls

118 lines (76 loc) · 4.3 KB
Raw

code-of-conduct-path NPM version NPM monthly downloads NPM total downloads Linux Build Status

Get the path to the Code of Conduct (contributor covenent) file in a local repository.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your ❤️ and support.

Install

Install with npm:

$ npm install --save code-of-conduct-path

Why?

I'm using this to programmatically lint my own GitHub repostories for Code of Conduct files, to:

  1. Ensure that the file exists
  2. Ensure that the file is consistently named across all of my projects
  3. Check the contents to ensure it is up-to-date

Usage

Get a code of conduct file from the current working directory.

var coc = require('code-of-conduct-path');
console.log(coc());
//=> '/dev/some-project/code-of-conduct.md'

Get the code of conduct file from the specified directory:

console.log(coc('my-projects/foo'));
//=> '/dev/my-projects/foo/code-of-conduct.md'

File patterns

Detects all of the following file patterns (node_modules is ignored):

**/coc
**/coc.md
**/code-of-conduct
**/code-of-conduct.md
**/code_of_conduct
**/code_of_conduct.md
**/contributor-covenent
**/contributor-covenent.md
**/contributor_covenent
**/contributor_covenent.md

Pull requests

Please submit a pull request if you would like to add one or more file patterns.

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

Running Tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test
Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Related projects

You might also be interested in these projects:

  • gh-clone: git clone a repo with only username/repo, or if it's an NPM package you can… more | homepage
  • gh-stars: API and CLI for getting the stars for one or more GitHub users or organizations. | homepage
  • github-base: JavaScript wrapper that greatly simplifies working with GitHub's API. | homepage

Author

Jon Schlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.

This file was generated by verb-generate-readme, v0.6.0, on October 13, 2017.