@entva/styleguide 0.0.0

package/.github/workflows/ci.yml

@@ -0,0 +1,14 @@
+name: Check
+on: push
+jobs:
+  check:
+    name: Check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: '22.x'
+      - run: npm ci
+      - run: npm run check

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Maxim Degterev <max@degterev.me> (https://max.degterev.me)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,88 @@
+# Coding Style Guide
+
+![Welcome to the internet](https://i.kym-cdn.com/photos/images/newsfeed/000/221/156/welcome-to-internet.jpg)
+
+This repository serves as a reference for our coding standards. You can read the common section, or jump to language specific pages.
+
+- [JavaScript](javascript/README.md)
+- [TypeScript](typescript/README.md)
+- [React](react/README.md)
+- [CSS](css/README.md)
+- [HTML](html/README.md)
+
+## Common section
+
+This answers generic questions regardless of language or technology.
+
+## Table of Contents
+- [Tabs or Spaces?](#tabs-or-spaces)
+- [Maximum Line Length](#maximum-line-length)
+- [Blank Lines](#blank-lines)
+- [Trailing Whitespace](#trailing-whitespace)
+- [Encoding](#encoding)
+- [Naming Conventions](#naming-conventions)
+- [Annotations](#annotations)
+
+## Tabs or Spaces?
+
+Use **spaces only**, with **2 spaces** per indentation level. Never mix tabs and spaces.
+
+**[⬆ back to top](#table-of-contents)**
+
+## Maximum Line Length
+
+Limit all lines to a maximum of 100 characters. Going over the limit is tolerated, but frowned upon. Please try to avoid it.
+
+**[⬆ back to top](#table-of-contents)**
+
+## Blank Lines
+
+Separate top-level function and class definitions with a single blank line.
+
+Separate method definitions inside of a class with a single blank line.
+
+Use a single blank line within the bodies of methods or functions in cases where this improves readability (e.g., for the purpose of delineating logical sections).
+
+**[⬆ back to top](#table-of-contents)**
+
+## Trailing Whitespace
+
+Do not leave trailing whitespaces. Use plugins to highlight that for you.
+
+## Encoding
+
+UTF-8 is the source file encoding.
+
+**[⬆ back to top](#table-of-contents)**
+
+## Annotations
+
+Use annotations when necessary to describe a specific action that must be taken against the indicated block of code.
+
+Write the annotation on the line immediately above the code that the annotation is describing.
+
+The annotation keyword should be followed by a colon and a space, and a descriptive note.
+
+```javascript
+  // FIXME: The client's current state should *not* affect payload processing.
+  resetClientState();
+  processPayload();
+```
+
+If multiple lines are required by the description, indent subsequent lines to match the text offset:
+
+```javascript
+  // TODO: Ensure that the value returned by this call falls within a certain
+  //       range, or throw an exception.
+  analyze();
+```
+
+Annotation types:
+
+- `TODO`: describe missing functionality that should be added at a later date
+- `FIXME`: describe broken code that must be fixed
+- `REVIEW`: describe code that should be reviewed to confirm implementation
+
+If a custom annotation is required, the annotation should be documented in the project's README.
+
+**[⬆ back to top](#table-of-contents)**

package/css/README.md

@@ -0,0 +1,385 @@
+# CSS / Sass / CSS Modules / CSS in JS Styleguide
+
+*A mostly reasonable approach to CSS*
+
+When you don't know if you can use a certain way of styling, see [https://caniuse.com](https://caniuse.com) to check. Sass language reference: [https://sass-lang.com/](https://sass-lang.com/). What are CSS Modules: [CSS Modules documentation](https://github.com/css-modules/css-modules). Same rules apply for CSS in JS (Styled Components, Emotion) as well.
+
+## Table of Contents
+
+1. [Terminology](#terminology)
+    - [Rule Declaration](#rule-declaration)
+    - [Selectors](#selectors)
+    - [Properties](#properties)
+1. [CSS](#css)
+    - [Formatting](#formatting)
+    - [Comments](#comments)
+    - [ID Selectors](#id-selectors)
+1. [Sass](#sass)
+    - [Syntax](#syntax)
+    - [Ordering](#ordering-of-property-declarations)
+    - [Variables](#variables)
+    - [Mixins](#mixins)
+    - [Extend directive](#extend-directive)
+    - [Nested selectors](#nested-selectors)
+    - [Naming conventions](#naming-conventions)
+    - [Units](#units)
+    - [Vendor Prefixes](#vendor-prefixes)
+    - [Strings](#strings)
+    - [Numbers](#numbers)
+    - [Calculations](#calculations)
+    - [Colors](#colors)
+    - [Imports](#imports)
+    - [Extend](#extend)
+    - [Functions](#functions)
+1. [CSS Modules](#css-modules)
+
+## Terminology
+
+### Rule declaration
+
+A “rule declaration” is the name given to a selector (or a group of selectors) with an accompanying group of properties. Here's an example:
+
+```css
+.listing {
+  font-size: 18px;
+  line-height: 1.2;
+}
+```
+
+### Selectors
+
+In a rule declaration, “selectors” are the bits that determine which elements in the DOM tree will be styled by the defined properties. Selectors can match HTML elements, as well as an element's class, ID, or any of its attributes. Here are some examples of selectors:
+
+```css
+.my-element-class {
+  /* ... */
+}
+
+[aria-hidden] {
+  /* ... */
+}
+```
+
+### Properties
+
+Finally, properties are what give the selected elements of a rule declaration their style. Properties are key-value pairs, and a rule declaration can contain one or more property declarations. Property declarations look like this:
+
+```css
+/* some selector */ {
+  background: #f1f1f1;
+  color: #333;
+}
+```
+
+**[⬆ back to top](#table-of-contents)**
+
+## CSS
+
+### Formatting
+
+* Use soft tabs (2 spaces) for indentation.
+* Use camelCase in class names (see [CSS Modules](#css-modules)).
+  - Use dashes outside of CSS modules
+* Do not use ID selectors.
+* When using multiple selectors in a rule declaration, give each selector its own line.
+* Put a space before the opening brace `{` in rule declarations.
+* In properties, put a space after, but not before, the `:` character.
+* Put closing braces `}` of rule declarations on a new line.
+* Put blank lines between rule declarations.
+
+**Bad**
+
+```css
+.avatar{
+    border-radius:50%;
+    border:2px solid white; }
+.no, .nope, .not_good {
+    // ...
+}
+#lol-no {
+  // ...
+}
+```
+
+**Good**
+
+```css
+.avatar {
+  border-radius: 50%;
+  border: 2px solid white;
+}
+
+.one,
+.selector,
+.per-line {
+  // ...
+}
+```
+
+### Comments
+
+* Prefer line comments (`//` in Sass-land) to block comments.
+* Prefer comments on their own line. Avoid end-of-line comments.
+* Write detailed comments for code that isn't self-documenting:
+  - Uses of z-index
+  - Compatibility or browser-specific hacks
+
+### ID selectors
+
+While it is possible to select elements by ID in CSS, it should generally be considered an anti-pattern. ID selectors introduce an unnecessarily high level of [specificity](https://developer.mozilla.org/en-US/docs/Web/CSS/Specificity) to your rule declarations and they are not reusable.
+
+For more on this subject, read [CSS Wizardry's article](http://csswizardry.com/2014/07/hacks-for-dealing-with-specificity/) on dealing with specificity.
+
+**[⬆ back to top](#table-of-contents)**
+
+## Sass
+
+### Syntax
+
+* Use the `.scss` syntax, never the original `.sass` syntax
+* Order your regular CSS and `@include` declarations logically (see below)
+
+### Ordering of property declarations
+
+1. Property declarations
+
+    List all standard property declarations, anything that isn't an `@include` or a nested selector.
+
+    ```scss
+    .btn-green {
+      background: green;
+      font-weight: bold;
+      // ...
+    }
+    ```
+
+2. `@include` declarations
+
+    Grouping `@include`s at the beginning makes it easier to read the entire selector and allows to override parts of the mixin.
+
+    ```scss
+    .btn-green {
+      @include transition(background 0.5s ease);
+      // ...
+      background: green;
+      font-weight: bold;
+    }
+    ```
+
+3. Nested selectors
+
+    Nested selectors, _if necessary_, go last, and nothing goes after them. Add whitespace between your rule declarations and nested selectors, as well as between adjacent nested selectors. Apply the same guidelines as above to your nested selectors.
+
+    ```scss
+    .btn {
+      @include transition(background 0.5s ease);
+
+      background: green;
+      font-weight: bold;
+
+      .icon {
+        margin-right: 10px;
+      }
+    }
+    ```
+
+### Variables
+
+Prefer camelCased variable names (e.g. `$myVariable`) over snake_cased variable names. It is acceptable to prefix variable names that are intended to be used only within the same file with an underscore (e.g. `$_myVariable`).
+
+### Mixins
+
+Mixins should be used to DRY up your code, add clarity, or abstract complexity - in much the same way as well-named functions. Mixins that accept no arguments can be useful for this, but note that if you are not compressing your payload (e.g. gzip), this may contribute to unnecessary code duplication in the resulting styles.
+
+### Extend directive
+
+`@extend` should be avoided because it has unintuitive and potentially dangerous behavior, especially when used with nested selectors. Even extending top-level placeholder selectors can cause problems if the order of selectors ends up changing later (e.g. if they are in other files and the order the files are loaded shifts). Gzipping should handle most of the savings you would have gained by using `@extend`, and you can DRY up your stylesheets nicely with mixins.
+
+### Nested selectors
+
+**Do not nest selectors more than three levels deep!**
+
+```scss
+.page-container {
+  .content {
+    .profile {
+      // STOP!
+    }
+  }
+}
+```
+
+When selectors become this long, you're likely writing CSS that is:
+
+* Strongly coupled to the HTML (fragile) *—OR—*
+* Overly specific (powerful) *—OR—*
+* Not reusable
+
+
+Again: **never nest ID selectors!**
+
+If you must use an ID selector in the first place (and you should really try not to), they should never be nested. If you find yourself doing this, you need to revisit your markup, or figure out why such strong specificity is needed. If you are writing well formed HTML and CSS, you should **never** need to do this.
+
+### Units
+
+Use `px` for `font-size`, because it offers absolute control over text. Additionally, unit-less `line-height` is preferred because it does not inherit a percentage value of its parent element, but instead is based on a multiplier of the `font-size`.
+
+When dealing with 0 omit units.
+
+```scss
+// bad
+$length: 0em;
+
+// good
+$length: 0;
+```
+
+### Vendor Prefixes
+Use autoprefixer instead of writing your own
+
+```scss
+// bad
+-webkit-border-radius: 4px;
+-moz-border-radius: 4px;
+border-radius: 4px;
+
+// good
+border-radius: 4px;
+```
+
+### Strings
+
+URLs and font names should be quoted. Use single quotes (`''`) and not double quotes (`"`).
+
+```scss
+// bad
+$fonts: "Helvetica Neue Light", "Helvetica", "Arial", sans-serif;
+
+// bad
+$fonts: Helvetica Neue Light, Helvetica, Arial, sans-serif;
+
+// good
+$fonts: 'Helvetica Neue Light', 'Helvetica', 'Arial', sans-serif;
+
+// good
+.foo {
+  background-image: url('/images/kittens.jpg');
+}
+
+// bad
+.foo {
+  background-image: url(/images/kittens.jpg);
+}
+```
+
+### Numbers
+
+Drop trailing and leading zeros before a decimal value when you can:
+
+```scss
+// bad
+.foo {
+  padding: 2.0em;
+  opacity: 0.5;
+}
+
+// good
+.foo {
+  padding: 2em;
+  opacity: .5;
+}
+```
+
+### Calculations
+
+Top-level numeric calculations should always be wrapped in parentheses.
+
+```scss
+// bad
+.foo {
+  width: 100% / 3;
+}
+
+// good
+.foo {
+  width: (100% / 3);
+}
+```
+
+### Colors
+
+In order to make colors as simple as they can be, respect the following order of preference for color formats:
+
+1. Hexadecimal notation. Preferably lowercase and shortened when possible
+2. RGB notation
+
+When using HSL or RGB notation, always add a single space after a comma (,) and no space between parentheses ((, )) and content.
+
+```scss
+// bad
+.foo {
+  color: red;
+}
+
+// bad
+.foo {
+  color: #ff0000;
+}
+
+// bad
+.foo {
+  color: rgba( 0,0,0,0.1 );
+}
+
+// good
+.foo {
+  color: #f00;
+}
+
+// good
+.foo {
+  color: rgba(0, 0, 0, .1);
+}
+```
+
+### Functions
+
+We prefer using mixins over functions. If a function is absolutely necessary, document where it is used and why it wasn't possible to create a mixin.
+
+**[⬆ back to top](#table-of-contents)**
+
+## CSS Modules
+
+- Prefer using CSS Modules over global css code
+- Use camelCase for class names
+- Use simple class and variable names since both are scoped to the module
+- Always use `.module.css` or `.module.scss` extension
+- Do not expect any scss variables or mixins to be defined. You have to import them yourself.
+- Use Sass whenever possible over similar CSS module functionality (composition, variables, import)
+- CSS or Sass specific rules still apply (CSS Modules rules take precedence)
+
+```scss
+// bad
+.foo-bar {
+  color: red;
+}
+
+// good
+.fooBar {
+  color: red;
+}
+```
+
+```jsx
+import styles from "./foo.module.scss"
+
+// ...
+
+// bad
+return <div className={styles['foo-bar']}>
+
+// good
+return <div className={styles.fooBar}>
+```
+
+**[⬆ back to top](#table-of-contents)**

package/css/packages/stylelint/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Maxim Degterev <max@degterev.me> (https://max.degterev.me)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/css/packages/stylelint/README.md

@@ -0,0 +1,27 @@
+# stylelint-config-entva
+
+> Shareable entva styleguide config for stylelint.
+
+Extends [`stylelint-config-standard`](https://github.com/stylelint/stylelint-config-standard).
+
+A shareable config to enforce entva styleguide: https://github.com/entva/styleguide
+
+To see the rules that this config uses, please read the [config itself](./index.js).
+
+## Installation
+
+```bash
+npm install stylelint-config-entva --save-dev
+```
+
+## Usage
+
+If you've installed `stylelint-config-entva` locally within your project, just set your `stylelint` config to:
+
+```json
+{
+  "extends": "stylelint-config-entva"
+}
+```
+
+## [MIT License](LICENSE)

package/css/packages/stylelint/eslint.config.js

@@ -0,0 +1,3 @@
+import baseConfig from 'entva-base';
+
+export default baseConfig;

package/css/packages/stylelint/index.js

@@ -0,0 +1,84 @@
+export default {
+  extends: 'stylelint-config-standard-scss',
+  plugins: [
+    'stylelint-order',
+  ],
+  rules: {
+    'at-rule-empty-line-before': ['always', {
+      except: [
+        'blockless-after-same-name-blockless',
+        'first-nested',
+      ],
+      ignore: ['after-comment'],
+      ignoreAtRules: ['if', 'else'],
+    }],
+
+    'at-rule-no-unknown': null,
+    'at-rule-disallowed-list': ['extend'],
+
+    'color-named': 'never',
+
+    'declaration-empty-line-before': null,
+
+    'function-name-case': 'lower',
+
+    'max-nesting-depth': [3, { ignoreAtRules: ['media'] }],
+    // 'number-leading-zero': 'never',
+    'no-descending-specificity': null,
+
+    'selector-max-id': 0,
+    'selector-class-pattern': '^[a-zA-Z]+(-[\\w-]+)?$',
+
+    'scss/at-rule-no-unknown': true,
+    'scss/at-function-parentheses-space-before': 'never',
+    'scss/at-else-if-parentheses-space-before': 'never',
+    'scss/at-function-pattern': '^[a-z0-9_\\-]+$',
+    'scss/at-mixin-argumentless-call-parentheses': 'never',
+    'scss/at-mixin-pattern': '^[a-z0-9_\\-]+$',
+    'scss/comment-no-loud': true,
+    'scss/declaration-nested-properties': 'never',
+    'scss/dollar-variable-pattern': '^[a-z0-9_\\-]+$',
+    'scss/percent-placeholder-pattern': '^we-are-not-using-placeholders-at-this-time$',
+    'scss/at-import-partial-extension': null, // needed for node-sass-glob-importer to work
+    'scss/comment-no-empty': null,
+
+    'order/order': [
+      'dollar-variables',
+      'custom-properties',
+      {
+        type: 'at-rule',
+        name: 'include',
+      },
+      'declarations',
+      'rules',
+      {
+        type: 'at-rule',
+        name: 'keyframes',
+      },
+    ],
+    'selector-pseudo-class-no-unknown': [
+      true,
+      {
+        ignorePseudoClasses: [
+          'export',
+          'import',
+          'global',
+          'local',
+          'external',
+        ],
+      },
+    ],
+    'selector-type-no-unknown': [
+      true,
+      {
+        ignoreTypes: ['from'],
+      },
+    ],
+    'property-no-unknown': [
+      true,
+      {
+        ignoreSelectors: [':export', /^:import/],
+      },
+    ],
+  },
+};