-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(withConfig): use the new
withConfig
API in glamorous
This allows us to avoid some issues (like #6) and gives us more power to set the displayName (like when it's in an object for example)
- Loading branch information
Kent C. Dodds
committed
Aug 16, 2017
1 parent
af5f692
commit c696424
Showing
24 changed files
with
1,027 additions
and
350 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
{ | ||
"projectName": "babel-plugin-glamorous-displayname", | ||
"projectOwner": "bernard-lin", | ||
"files": [ | ||
"README.md" | ||
], | ||
"imageSize": 100, | ||
"commit": false, | ||
"contributors": [ | ||
{ | ||
"login": "bernard-lin", | ||
"name": "Bernard Lin", | ||
"avatar_url": "https://avatars0.githubusercontent.com/u/16327281?v=4", | ||
"profile": "https://github.com/bernard-lin", | ||
"contributions": [ | ||
"code", | ||
"doc", | ||
"test" | ||
] | ||
} | ||
{ | ||
"login": "kentcdodds", | ||
"name": "Kent C. Dodds", | ||
"avatar_url": "https://avatars.githubusercontent.com/u/1500684?v=3", | ||
"profile": "https://kentcdodds.com", | ||
"contributions": [ | ||
"code", | ||
"doc", | ||
"infra", | ||
"test" | ||
] | ||
}, | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,13 @@ | ||
{ | ||
"presets": ["es2015"], | ||
"plugins": ["transform-runtime"], | ||
} | ||
"presets": [ | ||
["env", { | ||
"targets": { | ||
"node": "4.5" | ||
} | ||
}] | ||
], | ||
"plugins": [ | ||
"transform-class-properties", | ||
"transform-object-rest-spread" | ||
] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
node_modules | ||
coverage | ||
dist |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
{ | ||
"extends": [ | ||
"kentcdodds", | ||
"kentcdodds/jest", | ||
"kentcdodds/prettier" | ||
], | ||
"rules": { | ||
"max-len": "off", | ||
"complexity": [2, 8], | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
* text=auto | ||
*.js text eol=lf |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
<!-- | ||
Thanks for your interest in the project. I appreciate bugs filed and PRs submitted! | ||
Please make sure that you are familiar with and follow the Code of Conduct for | ||
this project (found in the CODE_OF_CONDUCT.md file). | ||
Please fill out this template with all the relevant information so we can | ||
understand what's going on and fix the issue. | ||
I'll probably ask you to submit the fix (after giving some direction). If you've | ||
never done that before, that's great! Check this free short video tutorial to | ||
learn how: http://kcd.im/pull-request | ||
--> | ||
|
||
- `babel-plugin-glamorous-displayname` version: | ||
- `node` version: | ||
- `npm` (or `yarn`) version: | ||
|
||
Relevant code or config | ||
|
||
```javascript | ||
|
||
``` | ||
|
||
What you did: | ||
|
||
|
||
|
||
What happened: | ||
|
||
<!-- Please provide the full error message/screenshots/anything --> | ||
|
||
Reproduction repository: | ||
|
||
<!-- | ||
If possible, please create a repository that reproduces the issue with the | ||
minimal amount of code possible. | ||
--> | ||
|
||
Problem description: | ||
|
||
|
||
|
||
Suggested solution: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
<!-- | ||
Thanks for your interest in the project. Bugs filed and PRs submitted are appreciated! | ||
Please make sure that you are familiar with and follow the Code of Conduct for | ||
this project (found in the CODE_OF_CONDUCT.md file). | ||
Also, please make sure you're familiar with and follow the instructions in the | ||
contributing guidelines (found in the CONTRIBUTING.md file). | ||
If you're new to contributing to open source projects, you might find this free | ||
video course helpful: http://kcd.im/pull-request | ||
Please fill out the information below to expedite the review and (hopefully) | ||
merge of your pull request! | ||
--> | ||
|
||
<!-- What changes are being made? (What feature/bug is being fixed here?) --> | ||
**What**: | ||
|
||
<!-- Why are these changes necessary? --> | ||
**Why**: | ||
|
||
<!-- How were these changes implemented? --> | ||
**How**: | ||
|
||
<!-- Have you done all of these things? --> | ||
**Checklist**: | ||
<!-- add "N/A" to the end of each line that's irrelevant to your changes --> | ||
<!-- to check an item, place an "x" in the box like so: "- [x] Documentation" --> | ||
- [ ] Documentation | ||
- [ ] Tests | ||
- [ ] Ready to be merged <!-- In your opinion, is this ready to be merged as soon as it's reviewed? --> | ||
- [ ] Added myself to contributors table <!-- this is optional, see the contributing guidelines for instructions --> | ||
|
||
<!-- feel free to add additional comments --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,12 @@ | ||
/node_modules/ | ||
/dist | ||
*.log | ||
node_modules | ||
coverage | ||
yarn.lock | ||
package-lock.json | ||
dist | ||
.opt-in | ||
.opt-out | ||
.DS_Store | ||
.eslintcache | ||
|
||
# these cause more harm than good | ||
# when working with contributors | ||
package-lock.json | ||
yarn.lock |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
registry=http://registry.npmjs.org/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
sudo: false | ||
language: node_js | ||
cache: | ||
directories: | ||
- node_modules | ||
notifications: | ||
email: false | ||
node_js: | ||
- '8' | ||
script: | ||
- npm start validate | ||
after_success: | ||
- npx codecov | ||
# this is disabled for now because we need to get semantic-release working and it's not quite working right... | ||
# Try again later: `npx semantic-release-cli setup` | ||
# - npm i -g semantic-release@7 && semantic-release pre && npm publish && semantic-release post | ||
branches: | ||
only: | ||
- master |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# CHANGELOG | ||
|
||
The changelog is automatically updated using [semantic-release](https://github.com/semantic-release/semantic-release). | ||
You can see it on the [releases page](../../releases). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
# Contributing | ||
|
||
Thanks for being willing to contribute! | ||
|
||
**Working on your first Pull Request?** You can learn how from this *free* series | ||
[How to Contribute to an Open Source Project on GitHub][egghead] | ||
|
||
## Project setup | ||
|
||
1. Fork and clone the repo | ||
2. `$ npm install` to install dependencies | ||
3. `$ npm start validate` to validate you've got it working | ||
4. Create a branch for your PR | ||
|
||
This project uses [`nps`][nps] and you can run `npm start help` to see what | ||
scripts are available. | ||
|
||
> Tip: Keep your `master` branch pointing at the original repository and make | ||
> pull requests from branches on your fork. To do this, run: | ||
> | ||
> ``` | ||
> git remote add upstream https://github.com/bernard-lin/babel-plugin-glamorous-displayname.git | ||
> git fetch upstream | ||
> git branch --set-upstream-to=upstream/master master | ||
> ``` | ||
> | ||
> This will add the original repository as a "remote" called "upstream," | ||
> Then fetch the git information from that remote, then set your local `master` | ||
> branch to use the upstream master branch whenever you run `git pull`. | ||
> Then you can make all of your pull request branches based on this `master` | ||
> branch. Whenever you want to update your version of `master`, do a regular | ||
> `git pull`. | ||
## Add yourself as a contributor | ||
|
||
This project follows the [all contributors][all-contributors] specification. | ||
To add yourself to the table of contributors on the README.md, please use the | ||
automated script as part of your PR: | ||
|
||
```console | ||
npm start contributors.add | ||
``` | ||
|
||
Follow the prompt and commit `.all-contributorsrc` and `README.md` in the PR. | ||
If you've already added yourself to the list and are making | ||
a new type of contribution, you can run it again and select the added | ||
contribution type. | ||
|
||
## Committing and Pushing changes | ||
|
||
This project uses [`semantic-release`][semantic-release] to do automatic | ||
releases and generate a changelog based on the commit history. So we follow | ||
[a convention][convention] for commit messages. You don't have to follow this | ||
convention if you don't like to. Just know that when we merge your commit, we'll | ||
probably use "Squash and Merge" so we can change the commit message :) | ||
|
||
Please make sure to run the tests before you commit your changes. You can run | ||
`npm start test.update` which will update any snapshots that need updating. | ||
Make sure to include those changes (if they exist) in your commit. | ||
|
||
### opt into git hooks | ||
|
||
There are git hooks set up with this project that are automatically installed | ||
when you install dependencies. They're really handy, but are turned off by | ||
default (so as to not hinder new contributors). You can opt into these by | ||
creating a file called `.opt-in` at the root of the project and putting this | ||
inside: | ||
|
||
``` | ||
pre-commit | ||
``` | ||
|
||
## Help needed | ||
|
||
Please checkout the [the open issues][issues] | ||
|
||
Also, please watch the repo and respond to questions/bug reports/feature requests! Thanks! | ||
|
||
[egghead]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github | ||
[semantic-release]: https://npmjs.com/package/semantic-release | ||
[convention]: https://github.com/conventional-changelog/conventional-changelog-angular/blob/ed32559941719a130bb0327f886d6a32a8cbc2ba/convention.md | ||
[all-contributors]: https://github.com/kentcdodds/all-contributors | ||
[issues]: https://github.com/bernard-lin/babel-plugin-glamorous-displayname/issues | ||
[nps]: https://github.com/kentcdodds/nps |
Oops, something went wrong.