@jgarber/stylelint-config 0.2.0 → 0.4.0

package/.editorconfig

@@ -0,0 +1,10 @@
+# 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

@@ -0,0 +1,15 @@
+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

@@ -0,0 +1,27 @@
+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

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

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 Jason Garber
+Copyright (c) 2022–present Jason Garber
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,3 +1,52 @@
 # stylelint-config
 
-Shareable [Stylelint](https://stylelint.io) configurations.
+Shareable [Stylelint](https://stylelint.io) configuration.
+
+## Installation
+
+```sh
+npm install --save-dev @jgarber/stylelint-config
+```
+
+## Usage
+
+Stylelint supports [a variety of configuration file formats](https://stylelint.io/user-guide/configure).
+
+### YAML
+
+In a file named `.stylelintrc` or `.stylelintrc.yml`:
+
+```yaml
+---
+extends: "@jgarber/stylelint-config"
+---
+```
+
+### JSON
+
+In a file named `.stylelintrc` or `.stylelintrc.json`:
+
+```json
+{
+  "extends": "@jgarber/stylelint-config"
+}
+```
+
+### JavaScript
+
+In a JavaScript file using [CommonJS module](https://nodejs.org/api/modules.html) syntax:
+
+```js
+// stylelint.config.cjs
+module.exports = require('@jgarber/stylelint-config');
+```
+
+In a JavaScript file using [ECMAScript module (ESM)](https://nodejs.org/api/esm.html) syntax:
+
+```js
+// stylelint.config.mjs
+
+import config from '@jgarber/stylelint-config';
+
+export default config;
+```

package/eslint.config.js

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

package/index.js

@@ -1,10 +1,6 @@
 module.exports = {
   extends: 'stylelint-config-standard',
-
-  plugins: [
-    'stylelint-order'
-  ],
-
+  plugins: ['stylelint-order'],
   rules: {
     'order/properties-alphabetical-order': true
   }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@jgarber/stylelint-config",
-  "version": "0.2.0",
-  "description": "Shareable Stylelint configurations.",
+  "version": "0.4.0",
+  "description": "Shareable Stylelint configuration.",
   "keywords": [
     "stylelint",
     "stylelintconfig",
@@ -11,22 +11,27 @@
   "bugs": "https://github.com/jgarber623/stylelint-config/issues",
   "license": "MIT",
   "author": "Jason Garber <jason@sixtwothree.org> (https://sixtwothree.org)",
-  "files": [],
   "main": "index.js",
   "repository": "github:jgarber623/stylelint-config",
   "scripts": {
-    "test": "eslint ."
+    "lint": "eslint .",
+    "test": "jasmine"
   },
   "engines": {
     "node": ">=16.0.0"
   },
   "devDependencies": {
-    "@jgarber/eslint-config": "*"
+    "@jgarber/eslint-config": "^1.1.0",
+    "globals": "^13.20.0",
+    "jasmine": "^5.0.2",
+    "stylelint": "^15.10.1",
+    "stylelint-config-standard": "^34.0.0",
+    "stylelint-order": "^6.0.3"
   },
   "peerDependencies": {
-    "stylelint": "^14.6.1",
-    "stylelint-config-standard": "^25.0.0",
-    "stylelint-order": "^5.0.0"
+    "stylelint": ">=15.10.1",
+    "stylelint-config-standard": ">=34.0.0",
+    "stylelint-order": ">=6.0.3"
   },
   "publishConfig": {
     "access": "public"

package/spec/indexSpec.js

@@ -0,0 +1,22 @@
+const stylelint = require('stylelint');
+
+const config = require('../index');
+
+it('exports an Object', () => {
+  expect(config).toEqual(jasmine.objectContaining({ extends: 'stylelint-config-standard' }));
+});
+
+it('loads the config and validates correct syntax', async () => {
+  const results = await stylelint.lint({ code: 'html { margin: 0 }', config });
+
+  expect(results.errored).toBe(false);
+});
+
+it('loads the config and invalidates incorrect syntax', async () => {
+  const results = await stylelint.lint({ code: 'html { padding: 0; margin: 0 }', config });
+
+  const rules = results.results[0].warnings.map(({ rule }) => rule);
+
+  expect(results.errored).toBe(true);
+  expect(rules).toEqual(jasmine.arrayContaining(['declaration-block-single-line-max-declarations', 'order/properties-alphabetical-order']));
+});

package/spec/support/jasmine.json

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