@saashub/qoq-knip 0.9.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Łukasz Adamczyk
+
+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 @@
+# @saashub/qoq-knip

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@saashub/qoq-knip",
+  "description": "Knip configs template",
+  "license": "MIT",
+  "version": "0.9.0",
+  "main": "./lib/index.cjs",
+  "module": "./lib/index.mjs",
+  "types": "./lib/index.d.js",
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "module": "./lib/index.mjs",
+      "import": "./lib/index.mjs",
+      "require": "./lib/index.cjs",
+      "default": "./lib/index.mjs"
+    },
+    "./knipConfig": {
+      "types": "./lib/knipConfig.d.ts",
+      "module": "./lib/knipConfig.mjs",
+      "import": "./lib/knipConfig.mjs",
+      "require": "./lib/knipConfig.cjs",
+      "default": "./lib/knipConfig.mjs"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "rimraf ./lib && rollup -c --silent",
+    "test": "vitest run --coverage",
+    "qoq:check": "qoq --check",
+    "qoq:fix": "qoq --fix"
+  },
+  "dependencies": {
+    "knip": "5.30.1",
+    "lodash": "4.17.21"
+  },
+  "devDependencies": {
+    "@saashub/qoq-cli": "^0.9.0",
+    "@types/lodash": "4.17.7",
+    "rimraf": "6.0.1",
+    "rollup": "4.21.2",
+    "typescript": "5.6.2",
+    "vitest": "2.0.5"
+  },
+  "keywords": [
+    "Knip template",
+    "saashub",
+    "qoq",
+    "QualityOverQuantity"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/saashub-it/qoq.git",
+    "directory": "packages/knip"
+  },
+  "homepage": "https://github.com/saashub-it/qoq/tree/master/packages/knip",
+  "gitHead": "a66c128699cdadbf669da44c674cc6d312a8311a"
+}

package/qoq.config.js

@@ -0,0 +1,3 @@
+const config = require("../../qoq.config");
+
+module.exports = config;

package/rollup.config.mjs

@@ -0,0 +1,28 @@
+import typescript from '@rollup/plugin-typescript';
+
+const sourceDir = './src';
+const outputDir = './lib';
+const input = {
+  index: `${sourceDir}/index.ts`,
+  knipConfig: `${sourceDir}/knipConfig.ts`,
+};
+const plugins = [typescript({
+  exclude: ['**/*.spec.{js,ts}']
+})];
+
+export default {
+  input,
+  plugins,
+  output: [
+    {
+      dir: outputDir,
+      format: 'esm',
+      entryFileNames: '[name].mjs',
+    },
+    {
+      dir: outputDir,
+      format: 'cjs',
+      entryFileNames: '[name].cjs',
+    },
+  ],
+};

package/src/index.ts

@@ -0,0 +1,16 @@
+import { getKnipConfig } from './knipConfig';
+
+export const jsConfig = getKnipConfig();
+export const jsReactConfig = getKnipConfig('.src', ['.src/index.jsx'], ['.src/**/*.{js,jsx}']);
+export const tsConfig = getKnipConfig(
+  '.src',
+  ['.src/index.ts'],
+  ['.src/**/*.{js,ts}'],
+  ['package.json', 'tsconfig.json', '**/*.d.ts']
+);
+export const tsReactConfig = getKnipConfig(
+  '.src',
+  ['.src/index.tsx'],
+  ['.src/**/*.{js,jsx,ts,tsx}'],
+  ['package.json', 'tsconfig.json', '**/*.d.ts']
+);

package/src/knipConfig.spec.ts

@@ -0,0 +1,85 @@
+import { describe, it, expect } from 'vitest';
+
+import { getKnipConfig } from './knipConfig';
+
+describe('getKnipConfig', () => {
+  it('should return default values', () => {
+    const result = getKnipConfig();
+    expect(result).toEqual({
+      entry: ['.src/index.js'],
+      project: ['.src/**/*.js'],
+      ignore: ['package.json'],
+      ignoreDependencies: [],
+    });
+  });
+
+  it('should return custom srcPath', () => {
+    const srcPath = 'custom-src';
+    const result = getKnipConfig(srcPath);
+    expect(result).toEqual({
+      entry: [`${srcPath}/index.js`],
+      project: [`${srcPath}/**/*.js`],
+      ignore: ['package.json'],
+      ignoreDependencies: [],
+    });
+  });
+
+  it('should return custom entry', () => {
+    const entry = ['custom-entry.js'];
+    const result = getKnipConfig(undefined, entry);
+    expect(result).toEqual({
+      entry,
+      project: ['.src/**/*.js'],
+      ignore: ['package.json'],
+      ignoreDependencies: [],
+    });
+  });
+
+  it('should return custom project', () => {
+    const project = ['custom-project.js'];
+    const result = getKnipConfig(undefined, undefined, project);
+    expect(result).toEqual({
+      entry: ['.src/index.js'],
+      project,
+      ignore: ['package.json'],
+      ignoreDependencies: [],
+    });
+  });
+
+  it('should return custom ignore', () => {
+    const ignore = ['custom-ignore.js'];
+    const result = getKnipConfig(undefined, undefined, undefined, ignore);
+    expect(result).toEqual({
+      entry: ['.src/index.js'],
+      project: ['.src/**/*.js'],
+      ignore,
+      ignoreDependencies: [],
+    });
+  });
+
+  it('should return custom ignoreDependencies', () => {
+    const ignoreDependencies = ['custom-ignore-dependencies.js'];
+    const result = getKnipConfig(undefined, undefined, undefined, undefined, ignoreDependencies);
+    expect(result).toEqual({
+      entry: ['.src/index.js'],
+      project: ['.src/**/*.js'],
+      ignore: ['package.json'],
+      ignoreDependencies,
+    });
+  });
+
+  it('should return multiple custom values', () => {
+    const srcPath = 'custom-src';
+    const entry = ['custom-entry.js'];
+    const project = ['custom-project.js'];
+    const ignore = ['custom-ignore.js'];
+    const ignoreDependencies = ['custom-ignore-dependencies.js'];
+    const result = getKnipConfig(srcPath, entry, project, ignore, ignoreDependencies);
+    expect(result).toEqual({
+      entry,
+      project,
+      ignore,
+      ignoreDependencies,
+    });
+  });
+});

package/src/knipConfig.ts

@@ -0,0 +1,18 @@
+export const getKnipConfig: (
+  srcPath?: string,
+  entry?: string[],
+  project?: string[],
+  ignore?: string[],
+  ignoreDependencies?: string[]
+) => { entry: string[]; project: string[]; ignore: string[]; ignoreDependencies: string[] } = (
+  srcPath = '.src',
+  entry = [`${srcPath}/index.js`],
+  project = [`${srcPath}/**/*.js`],
+  ignore = ['package.json'],
+  ignoreDependencies = []
+) => ({
+  entry,
+  project,
+  ignore,
+  ignoreDependencies,
+});

package/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./lib",
+  },
+  "include": ["./src"]
+}

package/vitest.config.mjs

@@ -0,0 +1,3 @@
+import config from '../../vitest.config.mjs';
+
+export default config;