v1.1.0

misskey-dev · Dec 30, 2023 · 03e8bad · 03e8bad
1 parent e39f8e0
commit 03e8bad
Show file tree

Hide file tree

Showing 5 changed files with 1,475 additions and 35 deletions.
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -0,0 +1,122 @@
+module.exports = {
+	root: true,
+	parser: '@typescript-eslint/parser',
+	parserOptions: {
+		tsconfigRootDir: __dirname,
+		project: ['./tsconfig.json'],
+	},
+	plugins: [
+		'@typescript-eslint',
+		'import'
+	],
+	extends: [
+		'eslint:recommended',
+		'plugin:@typescript-eslint/recommended',
+		'plugin:import/recommended',
+		'plugin:import/typescript'
+	],
+	rules: {
+		'indent': ['warn', 'tab', {
+			'SwitchCase': 1,
+			'MemberExpression': 1,
+			'flatTernaryExpressions': true,
+			'ArrayExpression': 'first',
+			'ObjectExpression': 'first',
+		}],
+		'eol-last': ['error', 'always'],
+		'semi': ['error', 'always'],
+		'semi-spacing': ['error', { 'before': false, 'after': true }],
+		'quotes': ['warn', 'single'],
+		'comma-dangle': ['warn', 'always-multiline'],
+		'comma-spacing': ['error', { 'before': false, 'after': true }],
+		'array-bracket-spacing': ['error', 'never'],
+		'keyword-spacing': ['error', {
+			'before': true,
+			'after': true,
+		}],
+		'key-spacing': ['error', {
+			'beforeColon': false,
+			'afterColon': true,
+		}],
+		'arrow-spacing': ['error', {
+			'before': true,
+			'after': true,
+		}],
+		'brace-style': ['error', '1tbs', {
+			'allowSingleLine': true,
+		}],
+		'padded-blocks': ['error', 'never'],
+		/* TODO: path aliasを使わないとwarnする
+		'no-restricted-imports': ['warn', {
+			'patterns': [
+			]
+		}],
+		*/
+		'eqeqeq': ['error', 'always', { 'null': 'ignore' }],
+		'no-multi-spaces': ['error'],
+		'no-var': ['error'],
+		'prefer-arrow-callback': ['error'],
+		'no-throw-literal': ['error'],
+		'no-param-reassign': ['warn'],
+		'no-constant-condition': ['warn'],
+		'no-empty-pattern': ['warn'],
+		'no-async-promise-executor': ['off'],
+		'no-useless-escape': ['off'],
+		'no-multiple-empty-lines': ['error', { 'max': 1 }],
+		'no-control-regex': ['warn'],
+		'no-empty': ['warn'],
+		'no-inner-declarations': ['off'],
+		'no-sparse-arrays': ['off'],
+		'nonblock-statement-body-position': ['error', 'beside'],
+		'object-curly-spacing': ['error', 'always'],
+		'space-infix-ops': ['error'],
+		'space-before-blocks': ['error', 'always'],
+		'padding-line-between-statements': [
+			'error',
+			{ 'blankLine': 'always', 'prev': 'function', 'next': '*' },
+			{ 'blankLine': 'always', 'prev': '*', 'next': 'function' },
+		],
+		"lines-between-class-members": "off",
+		/* typescript-eslint では enforce に対応してないっぽい
+		'@typescript-eslint/lines-between-class-members': ['error', {
+			enforce: [{
+				blankLine: 'always',
+				prev: 'method',
+				next: '*',
+			}]
+		}],
+		*/
+		'@typescript-eslint/func-call-spacing': ['error', 'never'],
+		'@typescript-eslint/no-explicit-any': ['warn'],
+		'@typescript-eslint/no-unused-vars': ['warn'],
+		'@typescript-eslint/no-unnecessary-condition': ['warn'],
+		'@typescript-eslint/no-var-requires': ['warn'],
+		'@typescript-eslint/no-inferrable-types': ['warn'],
+		'@typescript-eslint/no-empty-function': ['off'],
+		'@typescript-eslint/no-non-null-assertion': ['warn'],
+		'@typescript-eslint/explicit-function-return-type': ['off'],
+		'@typescript-eslint/no-misused-promises': ['error', {
+			'checksVoidReturn': false,
+		}],
+		'@typescript-eslint/consistent-type-imports': 'off',
+		'@typescript-eslint/prefer-nullish-coalescing': [
+			'warn',
+		],
+		'@typescript-eslint/naming-convention': [
+			'error',
+			{
+				"selector": "typeLike",
+				"format": ["PascalCase"]
+			},
+			{
+				"selector": "typeParameter",
+				"format": []
+			}
+		],
+		'import/no-unresolved': ['off'],
+		'import/no-default-export': ['warn'],
+		'import/order': ['warn', {
+			'groups': ['builtin', 'external', 'internal', 'parent', 'sibling', 'index', 'object', 'type'],
+		}]
+	},
+};
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,5 @@
+/built
+
 # Logs
 logs
 *.log

diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@ Function for reading bmp and ico and returning a sharp instance
 Installation
 ----------------------------------------------------------------
 ```
-npm install git+https://github.com/misskey-dev/sharp-read-bmp.git
+npm install @misskey-dev/sharp-read-bmp
 ```
 
 Usage
@@ -19,3 +19,4 @@ const sharpCtx = await sharpBmp('favicon.ico', mime);
 
 console.log(await sharpCtx.metadata());
 ```
+c
diff --git a/package.json b/package.json
@@ -5,6 +5,7 @@
   "main": "built/index.js",
   "types": "built/index.d.ts",
   "scripts": {
+    "eslint": "eslint --quiet \"src/**/*.ts\"",
     "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --silent=false --verbose false",
     "build": "tsc"
   },
@@ -27,6 +28,10 @@
     "@swc/jest": "^0.2.29",
     "@types/node": "^18.19.4",
     "@types/sharp": "^0.31.1",
+    "@typescript-eslint/eslint-plugin": "^6.16.0",
+    "@typescript-eslint/parser": "^6.16.0",
+    "eslint": "^8.56.0",
+    "eslint-plugin-import": "^2.29.1",
     "file-type": "^18.7.0",
     "jest": "^29.7.0",
     "mkdirp": "^2.1.6",
-Original file line number
+Diff line change
@@ -1,3 +1,5 @@
+    /built
     # Logs
     logs
     *.log
@@ Expand Down @@