@reallavo/clonecheck 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.env.example +2 -0
- package/.gitattributes +1 -0
- package/.github/workflows/ci.yml +24 -0
- package/CONTRIBUTING.md +22 -0
- package/LICENSE +21 -0
- package/README.md +205 -0
- package/action/README.md +34 -0
- package/action/action.yml +50 -0
- package/clonecheck.config.json +5 -0
- package/docs/checks.md +44 -0
- package/docs/config.md +36 -0
- package/docs/scoring.md +20 -0
- package/eslint.config.js +29 -0
- package/examples/docker-compose-missing-env/.env.example +1 -0
- package/examples/docker-compose-missing-env/README.md +5 -0
- package/examples/docker-compose-missing-env/docker-compose.yml +12 -0
- package/examples/node-basic/.env.example +1 -0
- package/examples/node-basic/README.md +8 -0
- package/examples/node-basic/package.json +15 -0
- package/examples/node-basic/pnpm-lock.yaml +5 -0
- package/examples/node-basic/src-index.ts +1 -0
- package/examples/node-missing-env/.env.example +1 -0
- package/examples/node-missing-env/README.md +8 -0
- package/examples/node-missing-env/package.json +11 -0
- package/examples/node-missing-env/pnpm-lock.yaml +5 -0
- package/examples/node-missing-env/src/app.ts +14 -0
- package/examples/python-basic/.env.example +1 -0
- package/examples/python-basic/README.md +8 -0
- package/examples/python-basic/app.py +6 -0
- package/examples/python-basic/requirements.txt +1 -0
- package/package.json +40 -0
- package/packages/cli/LICENSE +21 -0
- package/packages/cli/README.md +15 -0
- package/packages/cli/package.json +55 -0
- package/packages/cli/src/index.ts +186 -0
- package/packages/cli/tsconfig.json +11 -0
- package/packages/core/LICENSE +21 -0
- package/packages/core/README.md +11 -0
- package/packages/core/package.json +51 -0
- package/packages/core/src/checks/ciPresence.ts +35 -0
- package/packages/core/src/checks/dockerComposeEnv.ts +61 -0
- package/packages/core/src/checks/envExample.ts +31 -0
- package/packages/core/src/checks/helpers.ts +54 -0
- package/packages/core/src/checks/index.ts +24 -0
- package/packages/core/src/checks/packageManagerConsistency.ts +65 -0
- package/packages/core/src/checks/portDocumentation.ts +62 -0
- package/packages/core/src/checks/projectFiles.ts +77 -0
- package/packages/core/src/checks/readmeCommands.ts +87 -0
- package/packages/core/src/checks/scriptsAvailability.ts +69 -0
- package/packages/core/src/config.ts +96 -0
- package/packages/core/src/detectors/dockerCompose.ts +62 -0
- package/packages/core/src/detectors/env.ts +189 -0
- package/packages/core/src/detectors/packageManager.ts +54 -0
- package/packages/core/src/detectors/ports.ts +99 -0
- package/packages/core/src/detectors/project.ts +50 -0
- package/packages/core/src/detectors/readme.ts +131 -0
- package/packages/core/src/index.ts +31 -0
- package/packages/core/src/reporters/index.ts +3 -0
- package/packages/core/src/reporters/json.ts +5 -0
- package/packages/core/src/reporters/labels.ts +40 -0
- package/packages/core/src/reporters/markdown.ts +63 -0
- package/packages/core/src/reporters/text.ts +108 -0
- package/packages/core/src/run.ts +111 -0
- package/packages/core/src/scoring.ts +60 -0
- package/packages/core/src/types.ts +85 -0
- package/packages/core/src/utils/files.ts +109 -0
- package/packages/core/tests/config.test.ts +53 -0
- package/packages/core/tests/detectors.test.ts +127 -0
- package/packages/core/tests/fixtures/docker-compose-missing-env/.env.example +1 -0
- package/packages/core/tests/fixtures/docker-compose-missing-env/README.md +5 -0
- package/packages/core/tests/fixtures/docker-compose-missing-env/docker-compose.yml +6 -0
- package/packages/core/tests/fixtures/env-missing/.env.example +1 -0
- package/packages/core/tests/fixtures/env-missing/README.md +6 -0
- package/packages/core/tests/fixtures/env-missing/package-lock.json +4 -0
- package/packages/core/tests/fixtures/env-missing/package.json +8 -0
- package/packages/core/tests/fixtures/env-missing/src.py +4 -0
- package/packages/core/tests/fixtures/node-pnpm-readme-npm/.env.example +1 -0
- package/packages/core/tests/fixtures/node-pnpm-readme-npm/README.md +8 -0
- package/packages/core/tests/fixtures/node-pnpm-readme-npm/package.json +8 -0
- package/packages/core/tests/fixtures/node-pnpm-readme-npm/pnpm-lock.yaml +1 -0
- package/packages/core/tests/fixtures/node-pnpm-readme-npm/src.ts +3 -0
- package/packages/core/tests/reporters.test.ts +43 -0
- package/packages/core/tests/run.test.ts +37 -0
- package/packages/core/tests/scoring.test.ts +33 -0
- package/packages/core/tsconfig.json +8 -0
- package/packages/npm/LICENSE +21 -0
- package/packages/npm/README.md +17 -0
- package/packages/npm/package.json +54 -0
- package/packages/npm/src/index.ts +2 -0
- package/packages/npm/tsconfig.json +12 -0
- package/pnpm-workspace.yaml +4 -0
- package/prettier.config.js +5 -0
- package/scripts/build-package.mjs +30 -0
- package/tsconfig.base.json +17 -0
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "clonecheck",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "Know if your repo is actually cloneable.",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"repository": {
|
|
7
|
+
"type": "git",
|
|
8
|
+
"url": "git+https://github.com/reallav0/clonecheck.git",
|
|
9
|
+
"directory": "packages/npm"
|
|
10
|
+
},
|
|
11
|
+
"bugs": {
|
|
12
|
+
"url": "https://github.com/reallav0/clonecheck/issues"
|
|
13
|
+
},
|
|
14
|
+
"homepage": "https://github.com/reallav0/clonecheck#readme",
|
|
15
|
+
"keywords": [
|
|
16
|
+
"clonecheck",
|
|
17
|
+
"cli",
|
|
18
|
+
"npx",
|
|
19
|
+
"developer-experience",
|
|
20
|
+
"repository",
|
|
21
|
+
"readme"
|
|
22
|
+
],
|
|
23
|
+
"license": "MIT",
|
|
24
|
+
"engines": {
|
|
25
|
+
"node": ">=20"
|
|
26
|
+
},
|
|
27
|
+
"main": "./dist/index.js",
|
|
28
|
+
"types": "./dist/index.d.ts",
|
|
29
|
+
"exports": {
|
|
30
|
+
".": {
|
|
31
|
+
"types": "./dist/index.d.ts",
|
|
32
|
+
"import": "./dist/index.js"
|
|
33
|
+
}
|
|
34
|
+
},
|
|
35
|
+
"bin": {
|
|
36
|
+
"clonecheck": "./dist/index.js"
|
|
37
|
+
},
|
|
38
|
+
"files": ["dist", "README.md", "LICENSE"],
|
|
39
|
+
"publishConfig": {
|
|
40
|
+
"registry": "https://registry.npmjs.org/"
|
|
41
|
+
},
|
|
42
|
+
"scripts": {
|
|
43
|
+
"build": "node ../../scripts/build-package.mjs .",
|
|
44
|
+
"dev": "tsx src/index.ts",
|
|
45
|
+
"lint": "eslint \"src/**/*.ts\"",
|
|
46
|
+
"scan": "tsx src/index.ts scan",
|
|
47
|
+
"test": "vitest run --passWithNoTests",
|
|
48
|
+
"typecheck": "tsc --noEmit",
|
|
49
|
+
"prepack": "pnpm build"
|
|
50
|
+
},
|
|
51
|
+
"dependencies": {
|
|
52
|
+
"@clonecheck/cli": "workspace:*"
|
|
53
|
+
}
|
|
54
|
+
}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { existsSync } from "node:fs";
|
|
2
|
+
import { readFile } from "node:fs/promises";
|
|
3
|
+
import path from "node:path";
|
|
4
|
+
import { build } from "tsup";
|
|
5
|
+
|
|
6
|
+
const packageDir = path.resolve(process.argv[2] ?? process.cwd());
|
|
7
|
+
const entry = path.join(packageDir, "src", "index.ts");
|
|
8
|
+
const packageJsonPath = path.join(packageDir, "package.json");
|
|
9
|
+
|
|
10
|
+
if (!existsSync(entry)) {
|
|
11
|
+
throw new Error(`Cannot find package entry: ${entry}`);
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
const packageJson = JSON.parse(await readFile(packageJsonPath, "utf8"));
|
|
15
|
+
const dependencies = Object.keys(packageJson.dependencies ?? {});
|
|
16
|
+
const peerDependencies = Object.keys(packageJson.peerDependencies ?? {});
|
|
17
|
+
|
|
18
|
+
process.chdir(packageDir);
|
|
19
|
+
|
|
20
|
+
await build({
|
|
21
|
+
entry: ["src/index.ts"],
|
|
22
|
+
format: ["esm"],
|
|
23
|
+
dts: true,
|
|
24
|
+
sourcemap: true,
|
|
25
|
+
clean: true,
|
|
26
|
+
outDir: "dist",
|
|
27
|
+
target: "es2022",
|
|
28
|
+
platform: "node",
|
|
29
|
+
external: [...dependencies, ...peerDependencies]
|
|
30
|
+
});
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
{
|
|
2
|
+
"compilerOptions": {
|
|
3
|
+
"target": "ES2022",
|
|
4
|
+
"lib": ["ES2022"],
|
|
5
|
+
"module": "NodeNext",
|
|
6
|
+
"moduleResolution": "NodeNext",
|
|
7
|
+
"strict": true,
|
|
8
|
+
"declaration": true,
|
|
9
|
+
"declarationMap": true,
|
|
10
|
+
"sourceMap": true,
|
|
11
|
+
"esModuleInterop": true,
|
|
12
|
+
"forceConsistentCasingInFileNames": true,
|
|
13
|
+
"resolveJsonModule": true,
|
|
14
|
+
"skipLibCheck": true,
|
|
15
|
+
"noUncheckedIndexedAccess": true
|
|
16
|
+
}
|
|
17
|
+
}
|