code-of-conduct-path

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 :heart: 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

$ npm install && npm test

$ 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

• github/jonschlinkert
• twitter/jonschlinkert

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.