Skip to content

Commit

Permalink
refactor: simplify package implementation
Browse files Browse the repository at this point in the history
BREAKING CHANGE:

The programmatic interface for `get-pkg-repo` expects the package
contents to be an object and not a string. If calling `get-pkg-repo`,
pass the package content string to `JSON.parse` prior to calling
`get-pkg-repo`.
  • Loading branch information
hutson committed Oct 22, 2018
1 parent b24c925 commit 23f7792
Show file tree
Hide file tree
Showing 20 changed files with 3,935 additions and 488 deletions.
44 changes: 44 additions & 0 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
version: 2

node_6: &node_6
docker:
- image: node:6@sha256:68d8ca89524a21200e6a3ec0948893f3fe2c9e807ecc2a74319fbee59a13d2c4

node_8: &node_8
docker:
- image: node:8@sha256:d97f5bf54e016ad55dd0475f8710b99be14884ab1afcae8875f8092341264b0c

node_next: &node_next
docker:
- image: node:latest@sha256:32d5d5435e5038028bd0c0871d256d5887b06c4315cb1a135bcf81e0735627c9

test_plan: &test_plan
steps:
- checkout
- restore_cache:
keys:
- v1-dependencies_test_plan
- run: yarn install --frozen-lockfile
- save_cache:
paths:
- node_modules
- ${HOME}/.cache/yarn
key: v1-dependencies_test_plan
- run: yarn test
- run: $(yarn bin)/codecov || echo "CodeCov did not collect coverage reports"

jobs:
node_6_test_plan:
<<: [*node_6, *test_plan]
node_8_test_plan:
<<: [*node_8, *test_plan]
node_next_test_plan:
<<: [*node_next, *test_plan]

workflows:
version: 2
build:
jobs:
- node_6_test_plan
- node_8_test_plan
- node_next_test_plan
1 change: 1 addition & 0 deletions .codecov.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
comment: off
12 changes: 0 additions & 12 deletions .editorconfig

This file was deleted.

3 changes: 3 additions & 0 deletions .eslintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"extends": "@hbetts/eslint-config"
}
5 changes: 0 additions & 5 deletions .jscsrc

This file was deleted.

15 changes: 0 additions & 15 deletions .jshintrc

This file was deleted.

3 changes: 3 additions & 0 deletions .nycrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"extends": "@hbetts/nyc-config"
}
35 changes: 0 additions & 35 deletions .travis.yml

This file was deleted.

45 changes: 45 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Contributing

## Getting Started

Fork the repository to your own account and then clone the repository to a suitable location on your local machine.

```bash
git clone [YOUR FORK OF THE PROJECT]
```

To update the project from within the project's folder you can run the following command:

```bash
git pull --rebase
```

### Building

Install the project's dependencies.

```bash
npm install
```

### Testing

To run the project's tests run the following command:

```bash
npm test
```

## Feature Requests

I'm always looking for suggestions to improve this project. If you have a suggestion for improving an existing feature, or would like to suggest a completely new feature, please file an issue with my [GitLab repository](https://github.com/conventional-changelog/get-pkg-repo/issues).

## Bug Reports

My project isn't always perfect, but I strive to always improve on that work. You may file bug reports on the [GitLab repository](https://github.com/conventional-changelog/get-pkg-repo/issues) site.

## Pull Requests

Along with my desire to hear your feedback and suggestions, I'm also interested in accepting direct assistance in the form of new code or documentation.

Please feel free to file merge requests against my [github repository](https://gitlab.com/conventional-changelog/get-pkg-repo/merge_requests).
File renamed without changes.
Loading

0 comments on commit 23f7792

Please sign in to comment.