Skip to content

Commit c4256b2

Browse files
committed
prep for npmjs
0 parents  commit c4256b2

22 files changed

Lines changed: 13124 additions & 0 deletions

.babelrc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"presets": ["@babel/preset-react", "@babel/preset-env"]
3+
}

.editorconfig

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# editorconfig.org
2+
root = true
3+
4+
[*]
5+
indent_style = space
6+
indent_size = 4
7+
end_of_line = lf
8+
charset = utf-8
9+
trim_trailing_whitespace = true
10+
insert_final_newline = true
11+
12+
[package.json]
13+
indent_style = space
14+
indent_size = 2
15+
16+
[.travis.yml]
17+
indent_style = space
18+
indent_size = 2

.eslintrc

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
{
2+
"extends": ["nfl", "prettier"],
3+
"env": {
4+
"browser": true,
5+
"mocha": true,
6+
"es6": true
7+
},
8+
"globals": {
9+
"expect": false,
10+
"sinon": false
11+
},
12+
"plugins": ["prettier"],
13+
"rules": {
14+
"prettier/prettier": [
15+
"error",
16+
{
17+
"printWidth": 80,
18+
"tabWidth": 4,
19+
"singleQuote": false,
20+
"trailingComma": "none",
21+
"bracketSpacing": false,
22+
"semi": true,
23+
"useTabs": false,
24+
"parser": "babylon",
25+
"jsxBracketSameLine": false
26+
}
27+
]
28+
}
29+
}

.gitignore

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
.DS_Store
2+
.eslintcache
3+
.idea
4+
coverage
5+
es
6+
lib
7+
node_modules
8+
npm-debug.log

.npmignore

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
.arcconfig
2+
.babelrc
3+
.editorconfig
4+
.eslintrc
5+
.gitignore
6+
.nvmrc
7+
*.yml
8+
AUTHORS
9+
CHANGELOG.md
10+
CODE_OF_CONDUCT.md
11+
CONTRIBUTE.md
12+
rollup.config.js
13+
coverage
14+
karma.config.js
15+
test/
16+
node_modules/
17+
src/
18+
travis.yml
19+
rollup.config.js

AUTHORS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Lawrence McDaniel <lpm0073@gmail.com>

CHANGELOG.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
## 0.1.0 (November 22, 2021)
2+
3+
- Initial public release to [npmjs.com](https://www.npmjs.com/package/react-mdr)
4+
5+
## 0.1.1 (November 23, 2021)
6+
- Build test and lint documentation.
7+
8+
## 0.1.3 (November 23, 2021)
9+
- Renamed to react-mdr

CODE_OF_CONDUCT.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to make participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
- Using welcoming and inclusive language
18+
- Being respectful of differing viewpoints and experiences
19+
- Gracefully accepting constructive criticism
20+
- Focusing on what is best for the community
21+
- Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
- The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
- Trolling, insulting/derogatory comments, and personal or political attacks
28+
- Public or private harassment
29+
- Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
- Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies within all project spaces, and it also applies when
49+
an individual is representing the project or its community in public spaces.
50+
Examples of representing a project or community include using an official
51+
project e-mail address, posting via an official social media account, or acting
52+
as an appointed representative at an online or offline event. Representation of
53+
a project may be further defined and clarified by project maintainers.
54+
55+
This Code of Conduct also applies outside the project spaces when there is a
56+
reasonable belief that an individual's behavior may have a negative impact on
57+
the project or its community.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported by contacting the project lead at <lpm0073@gmail.com>. All
63+
complaints will be reviewed and investigated and will result in a response that
64+
is deemed necessary and appropriate to the circumstances. The project lead is
65+
obligated to maintain confidentiality with regard to the reporter of an incident.
66+
Further details of specific enforcement policies may be posted separately.
67+
68+
Project maintainers who do not follow or enforce the Code of Conduct in good
69+
faith may face temporary or permanent repercussions as determined by other
70+
members of the project's leadership.
71+
72+
## Attribution
73+
74+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
75+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
76+
77+
[homepage]: https://www.contributor-covenant.org
78+
79+
For answers to common questions about this code of conduct, see
80+
https://www.contributor-covenant.org/faq

CONTRIBUTE.md

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
# How to Contribute
2+
3+
Hopefully this document makes the process for contributing clear and answers some questions that you may have.
4+
5+
## Code of Conduct
6+
7+
We have adopted the [Contributor Covenant](https://www.contributor-covenant.org/) as our Code of Conduct, and we expect project participants to adhere to it. Please read the full text so that you can understand what actions will and will not be tolerated.
8+
9+
## Open Development
10+
11+
All work on React Matrix Raining Letters ("MRL") happens directly on [GitHub](https://github.com/lpm0073/react-mdr/). Both core team members and external contributors send pull requests which go through the same review process.
12+
13+
## Semantic Versioning
14+
15+
React MRL follows [semantic versioning](https://semver.org/). We release patch versions for critical bugfixes, minor versions for new features or non-essential changes, and major versions for any breaking changes. When we make breaking changes, we also introduce deprecation warnings in a minor version so that our users learn about the upcoming changes and migrate their code in advance.
16+
17+
Every significant change is documented in the [changelog file](./CHANGELOG.md).
18+
19+
## Branch Organization
20+
21+
Submit all changes directly to the main branch. We don’t use separate branches for development or for upcoming releases. We do our best to keep main in good shape, with all tests passing.
22+
23+
Code that lands in main must be compatible with the latest stable release. It may contain additional features, but no breaking changes. We should be able to release a new minor version from the tip of main at any time.
24+
25+
## Bugs
26+
27+
**Where to Find Known Issues**
28+
29+
We are using [GitHub Issues](https://github.com/lpm0073/react-mdr/issues) for our public bugs. We keep a close eye on this and try to make it clear when we have an internal fix in progress. Before filing a new task, try to make sure your problem doesn’t already exist.
30+
31+
**Reporting New Issues**
32+
33+
The best way to get your bug fixed is to provide a reduced test case. This JSFiddle template is a great starting point.
34+
35+
## How to Get in Touch
36+
37+
Main contact: [Lawrence McDaniel](https://lawrencemcdaniel.com/contact)
38+
39+
## Proposing a Change
40+
41+
If you intend to change the public API, or make any non-trivial changes to the implementation, we recommend [filing an issue](https://github.com/lpm0073/react-mdr/issues/new). This lets us reach an agreement on your proposal before you put significant effort into it.
42+
43+
If you’re only fixing a bug, it’s fine to submit a pull request right away but we still recommend to file an issue detailing what you’re fixing. This is helpful in case we don’t accept that specific fix but want to keep track of the issue.
44+
45+
## Style Guide
46+
47+
We use an automatic code formatter called Prettier. Run yarn prettier after making any changes to the code.
48+
49+
Then, our linter will catch most issues that may exist in your code. You can check the status of your code styling by simply running yarn linc.
50+
51+
However, there are still some styles that the linter cannot pick up. If you are unsure about something, looking at Airbnb’s Style Guide will guide you in the right direction.
52+
53+
## Request for Comments (RFC)
54+
55+
Many changes, including bug fixes and documentation improvements can be implemented and reviewed via the normal GitHub pull request workflow.
56+
57+
Some changes though are “substantial”, and we ask that these be put through a bit of a design process and produce a consensus among the contributor team.
58+
59+
The “RFC” (request for comments) process is intended to provide a consistent and controlled path for new features to enter the project. You can contribute by visiting the rfcs repository.
60+
61+
## License
62+
63+
By contributing to React MRL, you agree that your contributions will be licensed under its [MIT license](./LICENSE).
64+
65+
## Development setup
66+
67+
This is a helpful article on explains much of the tooling of this repo: https://dev.to/jimjunior/how-to-create-an-npm-library-from-react-components-2m2
68+
69+
Following are docs on how to locally symlink your repo to your local npm evironment, which enables you to test locally, before you publish: https://docs.npmjs.com/cli/v8/commands/npm-link
70+
71+
And, if you need, how to unlink: https://stackoverflow.com/questions/19094630/how-do-i-uninstall-a-package-installed-using-npm-link
72+
73+
74+
```bash
75+
git clone https://github.com/lpm0073/react-mdr.git
76+
cd react-mdr
77+
yarn build
78+
```
79+
80+
If you want to rebuild fresh...
81+
82+
```bash
83+
npm install rollup --save-dev
84+
npm install @babel/cli @babel/core @babel/preset-env @babel/preset-react @rollup/plugin-babel --save-dev
85+
npm install rollup-plugin-styles autoprefixer --save-dev
86+
npm install @babel/runtime
87+
npm install @babel/plugin-transform-runtime --save-dev
88+
npm install rollup-plugin-sourcemaps --save-dev
89+
```
90+
91+
## Create a new release
92+
93+
```bash
94+
# 1.) increment package.json "version", on or around row 4.
95+
vim ./package.json
96+
97+
# 2.) Add to ./CHANGELOG.md
98+
vim ./CHANGELOG.md
99+
100+
# 3.) excecute the build script, which calls rollup/babel to rebuild the files in dist/
101+
npm run build
102+
103+
# 4.) create a new semantic release in github.com
104+
https://github.com/lpm0073/react-mdr/releases
105+
```

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) Lawrence P. McDaniel <lpm0073@gmail.com>
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

0 commit comments

Comments
 (0)