@jgarber/stylelint-config 1.0.0 → 1.0.1

package/index.js

@@ -5,8 +5,25 @@ module.exports = {
   ],
   plugins: ['stylelint-order'],
   rules: {
+    /*
+     * Specify the alphabetical order of properties within declaration blocks.
+     *
+     * @see {@link https://github.com/hudochenkov/stylelint-order/blob/master/rules/properties-alphabetical-order/README.md}
+     */
     'order/properties-alphabetical-order': true,
+
+    /*
+     * Specify Unix or Windows linebreaks.
+     *
+     * @see {@link https://github.com/elirasza/stylelint-stylistic/tree/main/lib/rules/linebreaks}
+     */
     'stylistic/linebreaks': 'unix',
+
+    /*
+     * Disallow the Unicode Byte Order Mark.
+     *
+     * @see {@link https://github.com/elirasza/stylelint-stylistic/tree/main/lib/rules/unicode-bom}
+     */
     'stylistic/unicode-bom': 'never'
   }
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jgarber/stylelint-config",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Shareable Stylelint configuration.",
   "keywords": [
     "stylelint",
@@ -23,17 +23,17 @@
   "devDependencies": {
     "@jgarber/eslint-config": "^1.1.0",
     "globals": "^13.20.0",
-    "jasmine": "^5.0.2",
-    "stylelint": "^15.10.1",
+    "jasmine": "^5.1.0",
+    "stylelint": "^15.10.2",
     "stylelint-config-standard": "^34.0.0",
     "stylelint-order": "^6.0.3",
     "stylelint-stylistic": "^0.4.3"
   },
   "peerDependencies": {
-    "stylelint": ">=15.10.1",
-    "stylelint-config-standard": ">=34.0.0",
-    "stylelint-order": ">=6.0.3",
-    "stylelint-stylistic": ">=0.4.3"
+    "stylelint": ">=15.10",
+    "stylelint-config-standard": ">=34.0",
+    "stylelint-order": ">=6.0",
+    "stylelint-stylistic": ">=0.4"
   },
   "publishConfig": {
     "access": "public"

package/.editorconfig

@@ -1,10 +0,0 @@
-# EditorConfig is awesome: https://EditorConfig.org
-root = true
-
-[*]
-charset = utf-8
-end_of_line = lf
-insert_final_newline = true
-indent_size = 2
-indent_style = space
-trim_trailing_whitespace = true

package/.github/dependabot.yml

@@ -1,15 +0,0 @@
-version: 2
-
-updates:
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      interval: "weekly"
-    assignees:
-      - "jgarber623"
-  - package-ecosystem: "npm"
-    directory: "/"
-    schedule:
-      interval: "monthly"
-    assignees:
-      - "jgarber623"

package/.github/workflows/ci.yml

@@ -1,27 +0,0 @@
-name: CI
-
-on: push
-
-jobs:
-  lint:
-    name: Lint files
-    runs-on: ubuntu-20.04
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version-file: ".nvmrc"
-          cache: npm
-      - run: npm ci
-      - run: npm run lint
-  test:
-    name: Test files
-    runs-on: ubuntu-20.04
-    steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
-        with:
-          node-version-file: ".nvmrc"
-          cache: npm
-      - run: npm ci
-      - run: npm test

package/.nvmrc

@@ -1 +0,0 @@
-lts/*

package/eslint.config.js

@@ -1,14 +0,0 @@
-const config = require('@jgarber/eslint-config');
-const globals = require('globals');
-
-module.exports = [
-  ...config,
-  {
-    files: ['spec/**/*[sS]pec.?(m)js'],
-    languageOptions: {
-      globals: {
-        ...globals.jasmine
-      }
-    }
-  }
-];

package/spec/indexSpec.js

@@ -1,38 +0,0 @@
-const stylelint = require('stylelint');
-
-const config = require('../index');
-
-it('exports an Object', () => {
-  expect(config).toEqual(jasmine.objectContaining({
-    extends: ['stylelint-config-standard', 'stylelint-stylistic/config'],
-    plugins: ['stylelint-order']
-  }));
-});
-
-it('loads the config and validates correct syntax', async () => {
-  const code = 'html { margin: 0; }\n';
-  const { errored } = await stylelint.lint({ code, config });
-
-  expect(errored).toBe(false);
-});
-
-it('loads the config and invalidates incorrect syntax', async () => {
-  const code = 'html {padding: 0\r\n; margin: 0 }';
-  const { errored, results } = await stylelint.lint({ code, config });
-
-  expect(errored).toBe(true);
-
-  expect(results[0].warnings.map(({ rule }) => rule))
-    .toEqual(jasmine.arrayContaining(
-      [
-        'order/properties-alphabetical-order',
-        'stylistic/block-closing-brace-newline-before',
-        'stylistic/block-opening-brace-newline-after',
-        'stylistic/declaration-block-semicolon-newline-after',
-        'stylistic/declaration-block-semicolon-space-before',
-        'stylistic/declaration-block-trailing-semicolon',
-        'stylistic/linebreaks',
-        'stylistic/no-missing-end-of-source-newline'
-      ]
-    ));
-});

package/spec/support/jasmine.json

@@ -1,14 +0,0 @@
-{
-  "spec_dir": "spec",
-  "spec_files": [
-    "**/*[sS]pec.?(m)js"
-  ],
-  "helpers": [
-    "helpers/**/*.?(m)js"
-  ],
-  "env": {
-    "failSpecWithNoExpectations": true,
-    "random": true,
-    "stopSpecOnExpectationFailure": false
-  }
-}