From ff8b1b1e1254de6ffcc4b401e8f48be0f5cdff97 Mon Sep 17 00:00:00 2001 From: Fuxing Loh Date: Tue, 13 Feb 2024 17:09:41 +0800 Subject: [PATCH] chore: migrate home for project maintainability --- .github/ISSUE_TEMPLATE/1-bug-report.md | 7 +- .github/ISSUE_TEMPLATE/3-general.md | 4 +- LICENSE | 2 + README.md | 4 +- example/contented.config.mjs | 6 +- example/docs/03-api.md | 4 +- example/docs/09-Others/99-contributing.md | 7 +- example/docs/09-ballad.md | 2 +- example/package.json | 2 +- example/vercel.json | 7 ++ netlify.toml | 3 - package.json | 4 +- packages/contented-pipeline-md/package.json | 2 +- packages/contented-pipeline/package.json | 2 +- packages/contented-preview/package.json | 2 +- packages/contented-processor/package.json | 2 +- packages/contented/package.json | 2 +- .../commands/contented/ContentedPreview.ts | 2 +- pnpm-lock.yaml | 76 +++++++++---------- 19 files changed, 69 insertions(+), 71 deletions(-) create mode 100644 example/vercel.json delete mode 100644 netlify.toml diff --git a/.github/ISSUE_TEMPLATE/1-bug-report.md b/.github/ISSUE_TEMPLATE/1-bug-report.md index a15c1bec..a8517316 100644 --- a/.github/ISSUE_TEMPLATE/1-bug-report.md +++ b/.github/ISSUE_TEMPLATE/1-bug-report.md @@ -4,11 +4,8 @@ about: Report a bug encountered with this project labels: kind/bug --- - + #### What happened: diff --git a/.github/ISSUE_TEMPLATE/3-general.md b/.github/ISSUE_TEMPLATE/3-general.md index 3200d0d5..e78ba794 100644 --- a/.github/ISSUE_TEMPLATE/3-general.md +++ b/.github/ISSUE_TEMPLATE/3-general.md @@ -4,6 +4,4 @@ about: General question about this project labels: kind/question --- - + diff --git a/LICENSE b/LICENSE index 9cf10627..d1272f13 100644 --- a/LICENSE +++ b/LICENSE @@ -1,5 +1,7 @@ MIT License +Copyright (c) 2022 Fuxing Loh + 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 diff --git a/README.md b/README.md index 0ab45947..59b71be2 100644 --- a/README.md +++ b/README.md @@ -92,7 +92,7 @@ export default { url: 'https://contented.dev', name: 'Contented', github: { - url: 'https://github.com/levaintech/contented', + url: 'https://github.com/fuxingloh/contented', }, }, processor: { @@ -128,6 +128,6 @@ export default { ### Examples - [developer.levain.tech](https://developer.levain.tech) Website Built with Contented -- [levaintech/contented/packages/contented-example](https://github.com/levaintech/contented/tree/main/packages/contented-example) +- [fuxingloh/contented/packages/contented-example](https://github.com/fuxingloh/contented/tree/main/packages/contented-example) - [levaintech/sticky/packages/docs](https://github.com/levaintech/sticky/tree/main/packages/docs) - [fuxingloh/jellyfishsdk-docs](https://github.com/fuxingloh/jellyfishsdk-docs) diff --git a/example/contented.config.mjs b/example/contented.config.mjs index 049a9279..bde68fed 100644 --- a/example/contented.config.mjs +++ b/example/contented.config.mjs @@ -4,7 +4,7 @@ const config = { url: 'https://contented.dev', name: 'Contented', github: { - url: 'https://github.com/levaintech/contented', + url: 'https://github.com/fuxingloh/contented', }, }, processor: { @@ -18,7 +18,7 @@ const config = { editOnGitHubLink: { type: 'string', resolve: () => { - return `https://github.com/levaintech/contented/edit/main/README.md`; + return `https://github.com/fuxingloh/contented/edit/main/README.md`; }, }, }, @@ -45,7 +45,7 @@ const config = { editOnGitHubLink: { type: 'string', resolve: (_, { file }) => { - return `https://github.com/levaintech/contented/edit/main/packages/contented-example/docs/${file.data.contented.filePath}`; + return `https://github.com/fuxingloh/contented/edit/main/packages/contented-example/docs/${file.data.contented.filePath}`; }, }, }, diff --git a/example/docs/03-api.md b/example/docs/03-api.md index dd38ab64..e0ee6d6a 100644 --- a/example/docs/03-api.md +++ b/example/docs/03-api.md @@ -34,7 +34,7 @@ const config = { url: 'https://contented.dev', name: 'Contented', github: { - url: 'https://github.com/levaintech/contented', + url: 'https://github.com/fuxingloh/contented', }, }, processor: { @@ -148,7 +148,7 @@ module.exports = { url: 'https://contented.dev', name: 'Contented', github: { - url: 'https://github.com/levaintech/contented', + url: 'https://github.com/fuxingloh/contented', }, }, processor: { diff --git a/example/docs/09-Others/99-contributing.md b/example/docs/09-Others/99-contributing.md index a38f90e8..c8c71324 100644 --- a/example/docs/09-Others/99-contributing.md +++ b/example/docs/09-Others/99-contributing.md @@ -1,8 +1,5 @@ # Contributing Guidelines -> Taken -> from [levaintech/.github/CONTRIBUTING.md](https://github.com/levaintech/.github/edit/main/CONTRIBUTING.md) - Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community. @@ -11,8 +8,8 @@ information to effectively respond to your bug report or contribution. ## Security issue notifications -If you discover a potential security issue in this project we ask that you notify Levain OSS Team via our -email [oss@levain.tech](mailto:oss@levain.tech). Please do **not** create a public GitHub issue. +If you discover a potential security issue in this project, we ask that you notify us privately. +Please do **not** create a public GitHub issue. ## Reporting Bugs/Feature Requests diff --git a/example/docs/09-ballad.md b/example/docs/09-ballad.md index 503f7c91..dccbbce0 100644 --- a/example/docs/09-ballad.md +++ b/example/docs/09-ballad.md @@ -97,6 +97,6 @@ contented generate ```shell github open pr -github click Netlify Preview +github click Vercel Preview github lgtm ``` diff --git a/example/package.json b/example/package.json index cec48e16..c905100b 100644 --- a/example/package.json +++ b/example/package.json @@ -3,7 +3,7 @@ "version": "0.0.0", "private": false, "repository": { - "url": "git+https://github.com/levaintech/contented" + "url": "git+https://github.com/fuxingloh/contented" }, "type": "module", "main": "dist/index.js", diff --git a/example/vercel.json b/example/vercel.json new file mode 100644 index 00000000..edfb25d6 --- /dev/null +++ b/example/vercel.json @@ -0,0 +1,7 @@ +{ + "$schema": "https://openapi.vercel.sh/vercel.json", + "installCommand": "pnpm install", + "buildCommand": "pnpm turbo run generate", + "outputDirectory": ".contented/.preview/out/", + "framework": "nextjs" +} diff --git a/netlify.toml b/netlify.toml deleted file mode 100644 index 6b475e5a..00000000 --- a/netlify.toml +++ /dev/null @@ -1,3 +0,0 @@ -[build] -publish = "example/.contented/.preview/out/" -command = "turbo run generate --filter=example --force" \ No newline at end of file diff --git a/package.json b/package.json index 078f7b1c..b87f2be4 100644 --- a/package.json +++ b/package.json @@ -17,7 +17,7 @@ }, "devDependencies": { "@jest/globals": "^29.7.0", - "@types/node": "^18.19.14", + "@types/node": "^18.19.15", "@workspace/eslint-config": "workspace:*", "@workspace/prettier-config": "workspace:*", "esbuild": "^0.20.0", @@ -31,7 +31,7 @@ "turbo": "^1.12.3", "typescript": "5.3.3" }, - "packageManager": "pnpm@8.15.1", + "packageManager": "pnpm@8.15.2", "engines": { "node": "^18 <19", "pnpm": "^8 <9" diff --git a/packages/contented-pipeline-md/package.json b/packages/contented-pipeline-md/package.json index a39d3540..a755330b 100644 --- a/packages/contented-pipeline-md/package.json +++ b/packages/contented-pipeline-md/package.json @@ -3,7 +3,7 @@ "version": "0.0.0", "private": false, "repository": { - "url": "git+https://github.com/levaintech/contented" + "url": "git+https://github.com/fuxingloh/contented" }, "type": "module", "main": "./dist/index.js", diff --git a/packages/contented-pipeline/package.json b/packages/contented-pipeline/package.json index 99e39dbe..faef5b41 100644 --- a/packages/contented-pipeline/package.json +++ b/packages/contented-pipeline/package.json @@ -3,7 +3,7 @@ "version": "0.0.0", "private": false, "repository": { - "url": "git+https://github.com/levaintech/contented" + "url": "git+https://github.com/fuxingloh/contented" }, "type": "module", "main": "./dist/index.js", diff --git a/packages/contented-preview/package.json b/packages/contented-preview/package.json index 11621c31..1cb09a53 100644 --- a/packages/contented-preview/package.json +++ b/packages/contented-preview/package.json @@ -3,7 +3,7 @@ "version": "0.0.0", "private": false, "repository": { - "url": "git+https://github.com/levaintech/contented" + "url": "git+https://github.com/fuxingloh/contented" }, "scripts": { "dev": "next dev", diff --git a/packages/contented-processor/package.json b/packages/contented-processor/package.json index aec083ec..c69e3767 100644 --- a/packages/contented-processor/package.json +++ b/packages/contented-processor/package.json @@ -3,7 +3,7 @@ "version": "0.0.0", "private": false, "repository": { - "url": "git+https://github.com/levaintech/contented" + "url": "git+https://github.com/fuxingloh/contented" }, "type": "module", "main": "./dist/index.js", diff --git a/packages/contented/package.json b/packages/contented/package.json index 49107256..a3f1d1f3 100644 --- a/packages/contented/package.json +++ b/packages/contented/package.json @@ -3,7 +3,7 @@ "version": "0.0.0", "private": false, "repository": { - "url": "git+https://github.com/levaintech/contented" + "url": "git+https://github.com/fuxingloh/contented" }, "type": "module", "main": "./dist/index.js", diff --git a/packages/contented/src/commands/contented/ContentedPreview.ts b/packages/contented/src/commands/contented/ContentedPreview.ts index a4c6cede..f774d421 100644 --- a/packages/contented/src/commands/contented/ContentedPreview.ts +++ b/packages/contented/src/commands/contented/ContentedPreview.ts @@ -54,6 +54,6 @@ function generateEnvData(preview: PreviewConfig): string { return [ `CONTENTED_PREVIEW_SITE_URL=${preview.url ?? 'https://contented.dev'}`, `CONTENTED_PREVIEW_SITE_NAME=${preview?.name ?? 'Contented'}`, - `CONTENTED_PREVIEW_GITHUB_URL=${preview?.github?.url ?? 'https://github.com/levaintech/contented'}`, + `CONTENTED_PREVIEW_GITHUB_URL=${preview?.github?.url ?? 'https://github.com/fuxingloh/contented'}`, ].join('\n'); } diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 24100101..7cbbb159 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -12,8 +12,8 @@ importers: specifier: ^29.7.0 version: 29.7.0 '@types/node': - specifier: ^18.19.14 - version: 18.19.14 + specifier: ^18.19.15 + version: 18.19.15 '@workspace/eslint-config': specifier: workspace:* version: link:workspace/eslint-config @@ -34,7 +34,7 @@ importers: version: 8.0.3 jest: specifier: 29.7.0 - version: 29.7.0(@types/node@18.19.14) + version: 29.7.0(@types/node@18.19.15) lint-staged: specifier: ^15.2.2 version: 15.2.2 @@ -971,7 +971,7 @@ packages: engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: '@jest/types': 29.6.3 - '@types/node': 18.19.14 + '@types/node': 18.19.15 chalk: 4.1.2 jest-message-util: 29.7.0 jest-util: 29.7.0 @@ -992,14 +992,14 @@ packages: '@jest/test-result': 29.7.0 '@jest/transform': 29.7.0 '@jest/types': 29.6.3 - '@types/node': 18.19.14 + '@types/node': 18.19.15 ansi-escapes: 4.3.2 chalk: 4.1.2 ci-info: 3.9.0 exit: 0.1.2 graceful-fs: 4.2.11 jest-changed-files: 29.7.0 - jest-config: 29.7.0(@types/node@18.19.14) + jest-config: 29.7.0(@types/node@18.19.15) jest-haste-map: 29.7.0 jest-message-util: 29.7.0 jest-regex-util: 29.6.3 @@ -1027,7 +1027,7 @@ packages: dependencies: '@jest/fake-timers': 29.7.0 '@jest/types': 29.6.3 - '@types/node': 18.19.14 + '@types/node': 18.19.15 jest-mock: 29.7.0 dev: true @@ -1054,7 +1054,7 @@ packages: dependencies: '@jest/types': 29.6.3 '@sinonjs/fake-timers': 10.3.0 - '@types/node': 18.19.14 + '@types/node': 18.19.15 jest-message-util: 29.7.0 jest-mock: 29.7.0 jest-util: 29.7.0 @@ -1087,7 +1087,7 @@ packages: '@jest/transform': 29.7.0 '@jest/types': 29.6.3 '@jridgewell/trace-mapping': 0.3.20 - '@types/node': 18.19.14 + '@types/node': 18.19.15 chalk: 4.1.2 collect-v8-coverage: 1.0.2 exit: 0.1.2 @@ -1197,7 +1197,7 @@ packages: dependencies: '@types/istanbul-lib-coverage': 2.0.5 '@types/istanbul-reports': 3.0.3 - '@types/node': 18.19.14 + '@types/node': 18.19.15 '@types/yargs': 15.0.17 chalk: 4.1.2 dev: true @@ -1209,7 +1209,7 @@ packages: '@jest/schemas': 29.6.3 '@types/istanbul-lib-coverage': 2.0.5 '@types/istanbul-reports': 3.0.3 - '@types/node': 18.19.14 + '@types/node': 18.19.15 '@types/yargs': 17.0.29 chalk: 4.1.2 dev: true @@ -1588,7 +1588,7 @@ packages: /@types/graceful-fs@4.1.8: resolution: {integrity: sha512-NhRH7YzWq8WiNKVavKPBmtLYZHxNY19Hh+az28O/phfp68CF45pMFud+ZzJ8ewnxnC5smIdF3dqFeiSUQ5I+pw==} dependencies: - '@types/node': 18.19.14 + '@types/node': 18.19.15 dev: true /@types/hast@3.0.4: @@ -1599,7 +1599,7 @@ packages: /@types/ignore-walk@4.0.3: resolution: {integrity: sha512-6V7wDsk0nz8LtRC7qeC0GfXadFLT4FdCtVbXhxoIGRdkn2kLr20iMLupRGiBhlZ79WWWqaObIdR3nkXfUrBPdQ==} dependencies: - '@types/node': 18.19.14 + '@types/node': 18.19.15 dev: true /@types/istanbul-lib-coverage@2.0.5: @@ -1657,8 +1657,8 @@ packages: resolution: {integrity: sha512-wf3Vz+jCmOQ2HV1YUJuCWdL64adYxumkrxtc+H1VUQlnQI04+5HtH+qZCOE21lBE7gIrt+CwX2Wv8Acrw5Ak6w==} dev: true - /@types/node@18.19.14: - resolution: {integrity: sha512-EnQ4Us2rmOS64nHDWr0XqAD8DsO6f3XR6lf9UIIrZQpUzPVdN/oPuEzfDWNHSyXLvoGgjuEm/sPwFGSSs35Wtg==} + /@types/node@18.19.15: + resolution: {integrity: sha512-AMZ2UWx+woHNfM11PyAEQmfSxi05jm9OlkxczuHeEqmvwPkYj6MWv44gbzDPefYOLysTOFyI3ziiy2ONmUZfpA==} dependencies: undici-types: 5.26.5 dev: true @@ -2530,7 +2530,7 @@ packages: layout-base: 1.0.2 dev: false - /create-jest@29.7.0(@types/node@18.19.14): + /create-jest@29.7.0(@types/node@18.19.15): resolution: {integrity: sha512-Adz2bdH0Vq3F53KEMJOoftQFutWCukm6J24wbPWRO4k1kMY7gS7ds/uoJkNuV8wDCtWWnuwGcJwpWcih+zEW1Q==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} hasBin: true @@ -2539,7 +2539,7 @@ packages: chalk: 4.1.2 exit: 0.1.2 graceful-fs: 4.2.11 - jest-config: 29.7.0(@types/node@18.19.14) + jest-config: 29.7.0(@types/node@18.19.15) jest-util: 29.7.0 prompts: 2.4.2 transitivePeerDependencies: @@ -4521,7 +4521,7 @@ packages: '@jest/expect': 29.7.0 '@jest/test-result': 29.7.0 '@jest/types': 29.6.3 - '@types/node': 18.19.14 + '@types/node': 18.19.15 chalk: 4.1.2 co: 4.6.0 dedent: 1.5.1 @@ -4542,7 +4542,7 @@ packages: - supports-color dev: true - /jest-cli@29.7.0(@types/node@18.19.14): + /jest-cli@29.7.0(@types/node@18.19.15): resolution: {integrity: sha512-OVVobw2IubN/GSYsxETi+gOe7Ka59EFMR/twOU3Jb2GnKKeMGJB5SGUUrEz3SFVmJASUdZUzy83sLNNQ2gZslg==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} hasBin: true @@ -4556,10 +4556,10 @@ packages: '@jest/test-result': 29.7.0 '@jest/types': 29.6.3 chalk: 4.1.2 - create-jest: 29.7.0(@types/node@18.19.14) + create-jest: 29.7.0(@types/node@18.19.15) exit: 0.1.2 import-local: 3.1.0 - jest-config: 29.7.0(@types/node@18.19.14) + jest-config: 29.7.0(@types/node@18.19.15) jest-util: 29.7.0 jest-validate: 29.7.0 yargs: 17.7.2 @@ -4570,7 +4570,7 @@ packages: - ts-node dev: true - /jest-config@29.7.0(@types/node@18.19.14): + /jest-config@29.7.0(@types/node@18.19.15): resolution: {integrity: sha512-uXbpfeQ7R6TZBqI3/TxCU4q4ttk3u0PJeC+E0zbfSoSjq6bJ7buBPxzQPL0ifrkY4DNu4JUdk0ImlBUYi840eQ==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} peerDependencies: @@ -4585,7 +4585,7 @@ packages: '@babel/core': 7.23.2 '@jest/test-sequencer': 29.7.0 '@jest/types': 29.6.3 - '@types/node': 18.19.14 + '@types/node': 18.19.15 babel-jest: 29.7.0(@babel/core@7.23.2) chalk: 4.1.2 ci-info: 3.9.0 @@ -4645,7 +4645,7 @@ packages: '@jest/environment': 29.7.0 '@jest/fake-timers': 29.7.0 '@jest/types': 29.6.3 - '@types/node': 18.19.14 + '@types/node': 18.19.15 jest-mock: 29.7.0 jest-util: 29.7.0 dev: true @@ -4661,7 +4661,7 @@ packages: dependencies: '@jest/types': 26.6.2 '@types/graceful-fs': 4.1.8 - '@types/node': 18.19.14 + '@types/node': 18.19.15 anymatch: 3.1.3 fb-watchman: 2.0.2 graceful-fs: 4.2.11 @@ -4684,7 +4684,7 @@ packages: dependencies: '@jest/types': 29.6.3 '@types/graceful-fs': 4.1.8 - '@types/node': 18.19.14 + '@types/node': 18.19.15 anymatch: 3.1.3 fb-watchman: 2.0.2 graceful-fs: 4.2.11 @@ -4735,7 +4735,7 @@ packages: engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: '@jest/types': 29.6.3 - '@types/node': 18.19.14 + '@types/node': 18.19.15 jest-util: 29.7.0 dev: true @@ -4795,7 +4795,7 @@ packages: '@jest/test-result': 29.7.0 '@jest/transform': 29.7.0 '@jest/types': 29.6.3 - '@types/node': 18.19.14 + '@types/node': 18.19.15 chalk: 4.1.2 emittery: 0.13.1 graceful-fs: 4.2.11 @@ -4826,7 +4826,7 @@ packages: '@jest/test-result': 29.7.0 '@jest/transform': 29.7.0 '@jest/types': 29.6.3 - '@types/node': 18.19.14 + '@types/node': 18.19.15 chalk: 4.1.2 cjs-module-lexer: 1.2.3 collect-v8-coverage: 1.0.2 @@ -4849,7 +4849,7 @@ packages: resolution: {integrity: sha512-S5wqyz0DXnNJPd/xfIzZ5Xnp1HrJWBczg8mMfMpN78OJ5eDxXyf+Ygld9wX1DnUWbIbhM1YDY95NjR4CBXkb2g==} engines: {node: '>= 10.14.2'} dependencies: - '@types/node': 18.19.14 + '@types/node': 18.19.15 graceful-fs: 4.2.11 dev: true @@ -4886,7 +4886,7 @@ packages: engines: {node: '>= 10.14.2'} dependencies: '@jest/types': 26.6.2 - '@types/node': 18.19.14 + '@types/node': 18.19.15 chalk: 4.1.2 graceful-fs: 4.2.11 is-ci: 2.0.0 @@ -4898,7 +4898,7 @@ packages: engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: '@jest/types': 29.6.3 - '@types/node': 18.19.14 + '@types/node': 18.19.15 chalk: 4.1.2 ci-info: 3.9.0 graceful-fs: 4.2.11 @@ -4923,7 +4923,7 @@ packages: dependencies: '@jest/test-result': 29.7.0 '@jest/types': 29.6.3 - '@types/node': 18.19.14 + '@types/node': 18.19.15 ansi-escapes: 4.3.2 chalk: 4.1.2 emittery: 0.13.1 @@ -4935,7 +4935,7 @@ packages: resolution: {integrity: sha512-KWYVV1c4i+jbMpaBC+U++4Va0cp8OisU185o73T1vo99hqi7w8tSJfUXYswwqqrjzwxa6KpRK54WhPvwf5w6PQ==} engines: {node: '>= 10.13.0'} dependencies: - '@types/node': 18.19.14 + '@types/node': 18.19.15 merge-stream: 2.0.0 supports-color: 7.2.0 dev: true @@ -4944,13 +4944,13 @@ packages: resolution: {integrity: sha512-eIz2msL/EzL9UFTFFx7jBTkeZfku0yUAyZZZmJ93H2TYEiroIx2PQjEXcwYtYl8zXCxb+PAmA2hLIt/6ZEkPHw==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} dependencies: - '@types/node': 18.19.14 + '@types/node': 18.19.15 jest-util: 29.7.0 merge-stream: 2.0.0 supports-color: 8.1.1 dev: true - /jest@29.7.0(@types/node@18.19.14): + /jest@29.7.0(@types/node@18.19.15): resolution: {integrity: sha512-NIy3oAFp9shda19hy4HK0HRTWKtPJmGdnvywu01nOqNC2vZg+Z+fvJDxpMQA88eb2I9EcafcdjYgsDthnYTvGw==} engines: {node: ^14.15.0 || ^16.10.0 || >=18.0.0} hasBin: true @@ -4963,7 +4963,7 @@ packages: '@jest/core': 29.7.0 '@jest/types': 29.6.3 import-local: 3.1.0 - jest-cli: 29.7.0(@types/node@18.19.14) + jest-cli: 29.7.0(@types/node@18.19.15) transitivePeerDependencies: - '@types/node' - babel-plugin-macros @@ -7472,7 +7472,7 @@ packages: bs-logger: 0.2.6 esbuild: 0.20.0 fast-json-stable-stringify: 2.1.0 - jest: 29.7.0(@types/node@18.19.14) + jest: 29.7.0(@types/node@18.19.15) jest-util: 29.7.0 json5: 2.2.3 lodash.memoize: 4.1.2