Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jonschlinkert/code-of-conduct-path
Get the path to the Code of Conduct (contributor covenent) file in a local repository.
https://github.com/jonschlinkert/code-of-conduct-path
coc code-of-conduct contributor-covenant filepath javascript nodejs
Last synced: 2 months ago
JSON representation
Get the path to the Code of Conduct (contributor covenent) file in a local repository.
- Host: GitHub
- URL: https://github.com/jonschlinkert/code-of-conduct-path
- Owner: jonschlinkert
- License: mit
- Created: 2017-10-13T04:24:20.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2017-10-13T08:23:22.000Z (about 7 years ago)
- Last Synced: 2024-10-04T00:21:25.523Z (3 months ago)
- Topics: coc, code-of-conduct, contributor-covenant, filepath, javascript, nodejs
- Language: JavaScript
- Homepage: https://github.com/jonschlinkert
- Size: 11.7 KB
- Stars: 5
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# code-of-conduct-path [](https://www.npmjs.com/package/code-of-conduct-path) [](https://npmjs.org/package/code-of-conduct-path) [](https://npmjs.org/package/code-of-conduct-path) [](https://travis-ci.org/jonschlinkert/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](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ 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.
```js
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:
```js
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](../../issues/new).
Please read the [contributing guide](.github/contributing.md) 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:
```sh
$ npm install && npm test
```
Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
### Related projects
You might also be interested in these projects:
* [gh-clone](https://www.npmjs.com/package/gh-clone): git clone a repo with only username/repo, or if it's an NPM package you can… [more](https://github.com/jonschlinkert/gh-clone) | [homepage](https://github.com/jonschlinkert/gh-clone "git clone a repo with only username/repo, or if it's an NPM package you can use just the name of the project.")
* [gh-stars](https://www.npmjs.com/package/gh-stars): API and CLI for getting the stars for one or more GitHub users or organizations. | [homepage](https://github.com/jonschlinkert/gh-stars "API and CLI for getting the stars for one or more GitHub users or organizations.")
* [github-base](https://www.npmjs.com/package/github-base): JavaScript wrapper that greatly simplifies working with GitHub's API. | [homepage](https://github.com/jonschlinkert/github-base "JavaScript wrapper that greatly simplifies working with GitHub's API.")
### Author
**Jon Schlinkert**
* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
### License
Copyright © 2017, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on October 13, 2017._