Skip to content

Commit 2ec9bf7

Browse files
committed
Init rewrite branch
1 parent 5c47a42 commit 2ec9bf7

File tree

178 files changed

+42
-26405
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

178 files changed

+42
-26405
lines changed

.eslintrc

+7-2
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,12 @@
4242
"func-style": "off",
4343
"arrow-parens": "off",
4444
"no-use-before-define": "off",
45-
"no-undef": ["error", { "typeof": true }],
45+
"no-undef": [
46+
"error",
47+
{
48+
"typeof": true
49+
}
50+
],
4651
"react/jsx-filename-extension": "off",
4752
"react/require-extension": "off",
4853
"react/no-multi-comp": "off",
@@ -60,4 +65,4 @@
6065
}
6166
]
6267
}
63-
}
68+
}

.gitignore

+1-7
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,2 @@
11
node_modules
2-
package-lock.json
3-
dist
4-
lib
5-
es
6-
*.log
7-
.DS_Store
8-
.vscode
2+
yarn.lock

.prettierignore

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
1-
package-lock.json
1+
yarn.lock
22
package.json
33
node_modules
4-
dist
54
es
65
lib
7-
example/assets

CONTRIBUTING.md

+7-27
Original file line numberDiff line numberDiff line change
@@ -4,35 +4,21 @@ Thanks for contributing!
44

55
### Installing dependencies
66

7+
We use [`yarn`](https://yarnpkg.com/en/docs/getting-started).
8+
9+
Install all dependencies by running
10+
711
```sh
8-
yarn install
12+
yarn
913
```
1014

11-
You will find all building blocks that make up Spectacle in the [`src`](src) folder.
12-
1315
### Testing
1416

15-
You will find tests for files colocated with `*.test.js` suffixes. Whenever making any changes, ensure that all existing tests pass by running `yarn run test`.
16-
17-
If you are adding a new feature or some extra functionality, you should also make sure to accompany those changes with appropriate tests.
17+
@TODO
1818

1919
### Linting and Formatting
2020

21-
Before committing any changes, be sure to do `yarn run lint`; this will lint all relevant files using [ESLint](http://eslint.org/) and report on any changes that you need to make.
22-
23-
You will also want to ensure your code meets the prettier formatting guidelines by running `yarn run prettier -l <filename>` on a specific file. If there are differences the script errors out. You can also specify a glob `yarn run prettier -l "src/**/*.js"` which will return a list of files that do not conform.
24-
25-
Alternatively, install the Prettier [editor plugin](https://prettier.io/docs/en/editors.html) in your favorite editor. This is the preferred method.
26-
27-
There is also a pre-commit hook in place to lint all staged files. If any of the staged files do not conform to the eslint rules or the [prettier](https://prettier.io/) formatting guidelines, your commit will fail until you resolve all outstanding issues.
28-
29-
To resolve/fix prettier formatting problems from the CLI:
30-
31-
```sh
32-
yarn prettier-fix && yarn lint-fix
33-
```
34-
35-
This will modify your file in place. You will need to `git add` the file again and re-commit.
21+
@TODO
3622

3723
### Before submitting a PR...
3824

@@ -43,12 +29,6 @@ Thanks for taking the time to help us make Spectacle even better! Before you go
4329
- Update the [type definitions](./index.d.ts) for anything that modifies the Spectacle API, like breaking changes or new features.
4430
- Everything else included in our [pull request checklist](https://github.com/FormidableLabs/spectacle/blob/master/.github/PULL_REQUEST_TEMPLATE.md#checklist-feel-free-to-delete-this-section-upon-completion)
4531

46-
## Releasing a new version to NPM (only for project administrators)
47-
48-
1. Run `npm version patch` (or `minor`, `major` as appropriate) to run tests and lint, build the `lib` and `dist` directories, and automatically update the `package.json` with a new git tag.
49-
2. Run `npm publish` and publish to npm if all is well.
50-
3. Run `git push && git push --tags`
51-
5232
## Contributor Covenant Code of Conduct
5333

5434
### Our Pledge

0 commit comments

Comments
 (0)