Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zerotohero-dev/coding-standards
Byte-Sized JavaScript Coding Standards
https://github.com/zerotohero-dev/coding-standards
bytesized-javascript conventions default-ruleset education eslint javascript learning linter nodejs plugin podcast react ruleset screencast standards trainings tutorials vidcast videocast videos
Last synced: 7 days ago
JSON representation
Byte-Sized JavaScript Coding Standards
- Host: GitHub
- URL: https://github.com/zerotohero-dev/coding-standards
- Owner: zerotohero-dev
- License: other
- Created: 2016-12-08T15:01:12.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2017-12-24T04:05:28.000Z (almost 7 years ago)
- Last Synced: 2024-04-29T16:20:31.679Z (7 months ago)
- Topics: bytesized-javascript, conventions, default-ruleset, education, eslint, javascript, learning, linter, nodejs, plugin, podcast, react, ruleset, screencast, standards, trainings, tutorials, vidcast, videocast, videos
- Language: JavaScript
- Homepage: https://bytesized.tv/
- Size: 50.8 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[![tests][tests]][tests-url]
[![deps][deps]][deps-url]
[tests]: https://img.shields.io/travis/jsbites/coding-standards.svg
[tests-url]: https://travis-ci.org/jsbites/coding-standards
[deps]: https://david-dm.org/jsbites/coding-standards.svg
[deps-url]: https://david-dm.org/jsbites/coding-standards
```text
__ __
/ _) _ _ _ ) o _ _ (_ \
| | (_ (_) (_( ( ) ) (_( | |
( ( _) ) )
| |_ _ _)_ _ _ _ ) _ _ _ ) _ _| |
\__) ( (_ (_( ) ) (_( (_( ) (_( ( (__/
_) _)
```
**Byte-Sized JavaScript Coding Standards** is a repository to share common [ESLint](http://eslint.org/) rules that we use across all Byte-Sized JavaScript repositories.
The rulesets assume sane defaults. — You can directly use them in your projects our you can extend and customize them to suit your specific needs.
## Installation
Make sure that you have [ESLint](http://eslint.org/) installed in your project.
Install **Byte-Sized JavaScript Coding Standards** via npm:
```bash
npm install eslint-config-jsbites
```
## Usage Examples
Extend to `jbites` in your `.eslintrc` as follows:
```text
{
"extends": "jsbites"
}
```
Or if you are using [React](https://facebook.github.io/react/) in your project, use the the React-specific ruleset as follows:
```text
{
"extends": "jsbites/react"
}
```
Or if you are on a **Node.JS** runtime and/or you don’t use a transpiler at all, use the following ruleset:
```text
{
"extends": "jsbites/node"
}
```
That’s it!
## Dependencies
This module does not pre-install any dependencies.
So when running `eslint` if you might get an error message prompting you to install additional eslint parsers and plugins.
Most of the time what you will need to install will be self-explanatory when you look at the error message.
If you have any problems though, [feel free to file an issue](https://github.com/jsbites/coding-standards/issues/new).
## Package Scripts
Here are the helper npm scripts that you can run via `npm`:
* `npm test`: Executes the unit tests.
* `npm run lint`: Checks whether the source JavaScript is well-formed.
## Important Files and Folders
* `./index.js`: The default ruleset.
* `./react.js`: [React](https://facebook.github.io/react/)-specific rulest.
* `./node.js`: [Node.JS](https://nodejs.org/)-specific rulest.
* `CHANGELOG.md`: A log of what has been done since the last version.
* `CODE_OF_CONDUCT.md`: Tells the collaborators to be nice to each other.
* `README.md`: This very file.
## Wanna Help?
Any help is more than appreciated.
If you want to contribute to the source code, **fork this repository** and **create a pull request**.
> In lieu of a formal style guide, take care to maintain the existing coding style.
Also, don’t forget to add unit tests for any new or changed functionality.
If you want to report a bug; or share a comment or suggestion, [file an issue](https://github.com/jsbites/coding-standards/issues/new).
## I’ve Found a Bug; I Have an Idea
[For bug reports and suggestions, please file an issue](https://github.com/jsbites/coding-standards/issues/new).
## Contact Information
* **Project Maintainer**: [Volkan Özçelik](https://volkan.io/)
* **Project Website**: [bytesized.tv](https://bytesized.tv/)
## License
MIT-licensed. — [See the license file for details](LICENSE.md).
## Code of Conduct
We are committed to making participation in this project a harassment-free experience for everyone, regardless of the level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.
[See the code of conduct for details](CODE_OF_CONDUCT.md).
## A [ByteSized.TV][vidcast] Project
This repository is a part of the [Byte-Sized JavaScript VideoCasts][vidcast].
It is a compilation of short (_around ten minutes_) screencasts about **JavaScript** and related technologies.
[**Learn**, **explore**, and **have fun**][vidcast]!
[vidcast]: https://bytesized.tv/ "ByteSized.TV"