-
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
Base Rules
- Loading branch information
Showing
47 changed files
with
4,770 additions
and
5 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,28 @@ | ||
| # Copyright (c) 2018-present Arctic Ice Studio <development@arcticicestudio.com> | ||
| # Copyright (c) 2018-present Sven Greb <code@svengreb.de> | ||
|
|
||
| # Project: Styleguide JavaScript | ||
| # Repository: https://github.com/arcticicestudio/styleguide-javascript | ||
| # License: MIT | ||
| # References: | ||
| # https://circleci.com/docs/2.0 | ||
| # https://circleci.com/docs/2.0/circleci-images/#nodejs | ||
|
|
||
| version: 2 | ||
| jobs: | ||
| build: | ||
| docker: | ||
| - image: circleci/node:latest | ||
| steps: | ||
| - checkout | ||
| - run: | ||
| name: preprocess-clean-node-modules | ||
| command: rm -rf node_modules | ||
| - run: | ||
| name: preprocess-npm-install | ||
| command: npm install | ||
| - run: | ||
| name: generate-docs | ||
| command: npm run docs:build | ||
| - store_artifacts: | ||
| path: build/docs |
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,18 @@ | ||
| # +--------------------+ | ||
| # + Base Configuration + | ||
| # +--------------------+ | ||
| [*] | ||
| charset = utf-8 | ||
| end_of_line = lf | ||
| indent_size = 2 | ||
| indent_style = space | ||
| insert_final_newline = true | ||
| max_line_length = 120 | ||
| trim_trailing_whitespace = true | ||
|
|
||
| # +-----------+ | ||
| # + Languages + | ||
| # +-----------+ | ||
| # +--- Markdown ---+ | ||
| [*.{md,gfm}] | ||
| trim_trailing_whitespace = false |
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,8 @@ | ||
| # Automatically perform line feed (LF) normalization for files detected as text and leave all files detected as binary | ||
| # untouched. | ||
| * text=auto | ||
|
|
||
| # +--------+ | ||
| # + Assets + | ||
| # +--------+ | ||
| *.png binary |
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 @@ | ||
| # +---------+ | ||
| # + Node.js + | ||
| # +---------+ | ||
| node_modules/ | ||
| npm-debug.log* | ||
| .npm/ | ||
|
|
||
| # +-------------------+ | ||
| # + Project Structure + | ||
| # +-------------------+ | ||
| build/ |
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 @@ | ||
| package-lock=false | ||
| save-exact=true |
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
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
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,38 @@ | ||
| { | ||
| "name": "styleguide-javascript", | ||
| "title": "Styleguide JavaScript", | ||
| "version": "0.0.0", | ||
| "description": "The Arctic Ice Studio JavaScript Code Style.", | ||
| "author": { | ||
| "name": "Arctic Ice Studio", | ||
| "email": "development@arcticicestudio.com", | ||
| "url": "http://arcticicestudio.com" | ||
| }, | ||
| "homepage": "https://arcticicestudio.github.io/styleguide-javascript", | ||
| "repository": { | ||
| "type": "git", | ||
| "url": "git+https://github.com/arcticicestudio/styleguide-javascript.git" | ||
| }, | ||
| "bugs": { | ||
| "url": "https://github.com/arcticicestudio/styleguide-javascript/issues" | ||
| }, | ||
| "license": "MIT", | ||
| "keywords": [ | ||
| "styleguide", | ||
| "javascript", | ||
| "codestyle", | ||
| "ecmascript", | ||
| "eslint", | ||
| "eslintconfig" | ||
| ], | ||
| "private": true, | ||
| "scripts": { | ||
| "clean": "del build", | ||
| "docs:build": "gitbook install src && gitbook build src build/docs", | ||
| "docs:dev": "npm run docs:build && gitbook serve src build/docs" | ||
| }, | ||
| "devDependencies": { | ||
| "del-cli": "1.1.0", | ||
| "gitbook-cli": "2.3.2" | ||
| } | ||
| } |
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,48 @@ | ||
| <p align="center"><img src="https://rawgit.com/arcticicestudio/styleguide-javascript/develop/assets/styleguide-javascript-banner-typography.svg"/></p> | ||
|
|
||
| <p align="center"><img src="https://assets-cdn.github.com/favicon.ico" width=24 height=24/> <a href="https://github.com/arcticicestudio/styleguide-javascript/releases/latest"><img src="https://img.shields.io/github/release/arcticicestudio/styleguide-javascript.svg?style=flat-square"/></a></p> | ||
|
|
||
| <p align="center"><a href="https://github.com/arcticicestudio/styleguide-javascript/blob/develop/CHANGELOG.md"><img src="https://img.shields.io/badge/Changelog----5E81AC.svg?style=flat-square"/></a></p> | ||
|
|
||
| <p align="center">The Arctic Ice Studio JavaScript Code Style based on the <a href="https://github.com/airbnb/javascript">Airbnb JavaScript Style Guide</a>.</p> | ||
|
|
||
| --- | ||
|
|
||
| <p align="center"><img src="https://rawgit.com/arcticicestudio/styleguide-javascript/develop/assets/styleguide-javascript-banner-typography-badge.svg"/></p> | ||
|
|
||
| Every major open source project has its own style guide, a set of standards and conventions for the writing and design of code, documentations and assets. It is much easier to understand a large codebase when all the code in it is in a consistent style. | ||
|
|
||
| A style guide establishes and enforces style to improve the intelligibility and communication within the project community. It ensures consistency and enforces best practice in usage and language composition. | ||
|
|
||
| ### Getting Started | ||
|
|
||
| This style guide provides the [comprehensive base rule set][rules] including [ECMAScript +6 (ES 2015+) styles][rules-ecmascript_6+_styles]. | ||
|
|
||
| The development chapters contain information about the [requirements][dev-requirements] and [how to build][dev-building] this style guide documentation. | ||
|
|
||
| ### Contributing | ||
|
|
||
| Read the [contributing guide][dev-contributing] to learn about the development process and how to propose [enhancement suggestions][dev-contributing-enhancements] and [report bugs][dev-contributing-bug-reports], how to [submit pull requests][dev-contributing-pr] and the project's [styleguides][dev-contributing-styleguides], [branch organization][dev-contributing-branch-org] and [versioning][dev-contributing-versioning] model. | ||
|
|
||
| The guide also includes information about [minimal, complete, and verifiable examples][dev-contributing-mcve] and other ways to contribute to the project like [improving existing issues][dev-contributing-other-improve-issues] and [giving feedback on issues and pull requests][dev-contributing-other-feedback]. | ||
|
|
||
| <p align="center"><img src="https://cdn.rawgit.com/arcticicestudio/nord/develop/assets/banner-footer-mountains.svg" /></p> | ||
|
|
||
| <p align="center">Copyright © 2018-present Arctic Ice Studio & Sven Greb</p> | ||
|
|
||
| <p align="center"><a href="https://github.com/arcticicestudio/styleguide-javascript/blob/develop/LICENSE.md"><img src="https://img.shields.io/badge/License-MIT-5E81AC.svg?style=flat-square"/></a></p> | ||
|
|
||
| [dev-building]: development/building.md | ||
| [dev-contributing]: development/contributing.md | ||
| [dev-contributing-branch-org]: development/contributing.md#branch-organization | ||
| [dev-contributing-bug-reports]: development/contributing.md#bug-reports | ||
| [dev-contributing-enhancements]: development/contributing.md#enhancement-suggestions | ||
| [dev-contributing-mcve]: development/contributing.md#mcve | ||
| [dev-contributing-other-feedback]: development/contributing.md#give-feedback-on-issues-and-pull-requests | ||
| [dev-contributing-other-improve-issues]: development/contributing.md#improve-issues | ||
| [dev-contributing-pr]: development/contributing.md#pull-requests | ||
| [dev-contributing-styleguides]: development/contributing.md#styleguides | ||
| [dev-contributing-versioning]: development/contributing.md#versioning | ||
| [dev-requirements]: development/requirements.md | ||
| [rules]: rules/types.md | ||
| [rules-ecmascript_6+_styles]: rules/ecmascript_6+_styles.md |
Oops, something went wrong.