docs(changeset): update package.json config to include config files

Author: xbrave

.changeset/three-bags-drop.md

@@ -0,0 +1,5 @@
+---
+'ko-lint-config': patch
+---
+
+update package.json config to include config files

.prettierignore

@@ -3,4 +3,6 @@
 *.json
 /template/
 /.github/
-pnpm-lock.yaml
+pnpm-lock.yaml
+**/build
+**/lib

.prettierrc.json .prettierrc

@@ -5,8 +5,8 @@
   ],
   "scripts": {
     "prepare": "husky install",
-    "prettier:check": "prettier --check .",
-    "prettier:write": "prettier --write .",
+    "prettier:check": "prettier --config .prettierrc --ignore-path .gitignore --ignore-path .prettierignore --check .",
+    "prettier:write": "prettier --config .prettierrc --ignore-path .gitignore --ignore-path .prettierignore --write .",
     "check": "pnpm prettier",
     "test": "pnpm test",
     "debug:ko": "pnpm --filter ./packages/ko debug",

package.json

@@ -1,10 +1,10 @@
 module.exports = {
-    semi: true, // 行末添加分号
-    tabWidth: 4, // tab 缩进，默认 2
-    printWidth: 80, // 换行长度，默认 80
-    singleQuote: true, // 单引号
-    useTabs: false, // 使用 tab 缩进，默认 false 使用空格
-    bracketSpacing: true, // 对象中打印空格 默认 true
-    arrowParens: 'always', // 箭头函数参数括号 可选 avoid(一个参数时省略) | always
-    trailingComma: 'es5', // 尾逗号 可选 none | es5 | all
+  semi: true, // 行末添加分号
+  tabWidth: 4, // tab 缩进，默认 2
+  printWidth: 80, // 换行长度，默认 80
+  singleQuote: true, // 单引号
+  useTabs: false, // 使用 tab 缩进，默认 false 使用空格
+  bracketSpacing: true, // 对象中打印空格 默认 true
+  arrowParens: 'always', // 箭头函数参数括号 可选 avoid(一个参数时省略) | always
+  trailingComma: 'es5', // 尾逗号 可选 none | es5 | all
 };

packages/ko-lint-config/.eslintrc.js

@@ -1,33 +1,29 @@
 module.exports = {
-    files: ['**/*.css', '**/*.scss'],
-    customSyntax: require.resolve('postcss-scss'),
-    extends: 'stylelint-config-standard',
-    plugins: ['stylelint-order', 'stylelint-scss'],
-    rules: {
-        // null 为关闭规则
-        indentation: 4, // 缩进4格
-        'declaration-empty-line-before': 'never', // 第一条属性声明前不允许有空行
-        'selector-class-pattern': '[a-zA-Z]+', // className 的大小写
-        // 规则之前的空行
-        'rule-empty-line-before': [
-            'always',
-            {
-                except: [
-                    'inside-block',
-                    'first-nested',
-                    'after-single-line-comment',
-                ],
-            },
-        ],
-        'alpha-value-notation': 'number', // 小数显示数字(number)或百分数(percentage)
-        'color-function-notation': 'legacy', // 颜色 rgba 等使用传统逗号隔开
-        'color-hex-case': 'upper', // 颜色十六进制字符大写
-        'selector-list-comma-newline-after': 'always-multi-line',
-        'max-line-length': 300, // 最大宽度
-        'font-family-no-missing-generic-family-keyword': null, // 是否必须包含通用字体
-        'no-descending-specificity': null, // 选择器顺序
-        'keyframes-name-pattern': null, // keyframes 推荐小写+连字符命名
-        'no-empty-source': null, // 空文件
-        'block-no-empty': null, // 空规则
-    },
+  files: ['**/*.css', '**/*.scss'],
+  customSyntax: require.resolve('postcss-scss'),
+  extends: 'stylelint-config-standard',
+  plugins: ['stylelint-order', 'stylelint-scss'],
+  rules: {
+    // null 为关闭规则
+    indentation: 4, // 缩进4格
+    'declaration-empty-line-before': 'never', // 第一条属性声明前不允许有空行
+    'selector-class-pattern': '[a-zA-Z]+', // className 的大小写
+    // 规则之前的空行
+    'rule-empty-line-before': [
+      'always',
+      {
+        except: ['inside-block', 'first-nested', 'after-single-line-comment'],
+      },
+    ],
+    'alpha-value-notation': 'number', // 小数显示数字(number)或百分数(percentage)
+    'color-function-notation': 'legacy', // 颜色 rgba 等使用传统逗号隔开
+    'color-hex-case': 'upper', // 颜色十六进制字符大写
+    'selector-list-comma-newline-after': 'always-multi-line',
+    'max-line-length': 300, // 最大宽度
+    'font-family-no-missing-generic-family-keyword': null, // 是否必须包含通用字体
+    'no-descending-specificity': null, // 选择器顺序
+    'keyframes-name-pattern': null, // keyframes 推荐小写+连字符命名
+    'no-empty-source': null, // 空文件
+    'block-no-empty': null, // 空规则
+  },
 };

packages/ko-lint-config/.prettierrc.js

@@ -3,7 +3,7 @@ const eslint = require('eslint');
 const stylelint = require('stylelint');
 
 module.exports = {
-    prettier,
-    eslint,
-    stylelint,
+  prettier,
+  eslint,
+  stylelint,
 };

packages/ko-lint-config/.stylelintrc.js

@@ -4,6 +4,7 @@
   "description": "lint configs about eslint stylelint and prettier",
   "main": "index.js",
   "files": [
+    "**/*",
     "!test/**/*"
   ],
   "typings": "index.d.ts",

packages/ko-lint-config/index.js

@@ -3,13 +3,13 @@ const config = require('../');
 const test = require('tape');
 
 test('test basic properties of config', function (t) {
-    t.ok(isObject(config.parserOptions));
-    t.ok(isObject(config.env));
-    t.ok(isObject(config.globals));
-    t.ok(isObject(config.rules));
-    t.end();
+  t.ok(isObject(config.parserOptions));
+  t.ok(isObject(config.env));
+  t.ok(isObject(config.globals));
+  t.ok(isObject(config.rules));
+  t.end();
 });
 
 function isObject(obj) {
-    return typeof obj === 'object' && obj !== null;
+  return typeof obj === 'object' && obj !== null;
 }

packages/ko-lint-config/package.json

@@ -3,18 +3,18 @@ const { ESLint } = require('eslint');
 const test = require('tape');
 
 test('load config in eslint to validate all rule syntax is correct', async function (t) {
-    const eslint = new ESLint();
-    const code = 'const foo = 1\nconst bar = (val) => val + 1\nbar(foo)\n';
-    const [lintResult] = await eslint.lintText(code);
-    t.equal(lintResult.errorCount, 0);
-    t.end();
+  const eslint = new ESLint();
+  const code = 'const foo = 1\nconst bar = (val) => val + 1\nbar(foo)\n';
+  const [lintResult] = await eslint.lintText(code);
+  t.equal(lintResult.errorCount, 0);
+  t.end();
 });
 
 test('ensure we allow top level await', async function (t) {
-    const eslint = new ESLint();
-    const code =
-        'const foo = await 1\nconst bar = (val) => val + 2\nawait bar(foo)\n';
-    const [lintResult] = await eslint.lintText(code);
-    t.equal(lintResult.errorCount, 0);
-    t.end();
+  const eslint = new ESLint();
+  const code =
+    'const foo = await 1\nconst bar = (val) => val + 2\nawait bar(foo)\n';
+  const [lintResult] = await eslint.lintText(code);
+  t.equal(lintResult.errorCount, 0);
+  t.end();
 });

packages/ko-lint-config/test/basic.js

@@ -2,7 +2,7 @@
 /node_modules
 
 # Production
-/build
+**/build
 
 # Generated files
 .docusaurus