feat(cli-utils): doc

adevinta · Sep 27, 2023 · d9446aa · d9446aa
1 parent 0cb5640
commit d9446aa
Show file tree

Hide file tree

Showing 12 changed files with 152 additions and 5 deletions.
diff --git a/packages/utils/cli/LICENSE.md b/packages/utils/cli/LICENSE.md
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Adevinta ASA.
+
+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.
diff --git a/packages/utils/cli/README.md b/packages/utils/cli/README.md
@@ -1 +1,13 @@
-The documentation for this package is located within our Storybook at https://sparkui.vercel.app/?path=/docs/utils-cli--docs.
+# CLI
+> @spark-ui/cli-utils
+
+![storybook](https://img.shields.io/badge/storybook-black?logo=storybook&link=https%3A%2F%2Fsparkui.vercel.app%2F%3Fpath%3D%2Fdocs%2Futils-cli--docs)
+![documentation](https://img.shields.io/badge/documentation-black?logo=googledocs&link=https%3A%2F%2Fsparkui-adv.vercel.app%2Fdocs%2Futil%2Fcli)
+![issue](https://img.shields.io/badge/report%20a%20bug-black?logo=openbugbounty&logoColor=red&link=https%3A%2F%2Fgithub.com%2Fadevinta%2Fspark%2Fissues%2Fnew%3F%26projects%3D4%26template%3Dbug-report.yml%26assignees%3D%26labels%3Dutil%2Ccli)
+![npm](https://img.shields.io/npm/dt/%40spark-ui/cli-utils?logo=npm&labelColor=black&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2F%40spark-ui%2Fcli-utils)
+
+
+This package is part of the [`@spark-ui`](https://github.com/adevinta/spark) react-js user interface component library project.
+
+![Issues open](https://img.shields.io/github/issues-search/adevinta/spark?query=is%3Aopen%20label%3Autil%20label%3Acli&logo=openbugbounty&logoColor=red&label=issues%20open&color=red&link=https%3A%2F%2Fgithub.com%2Fadevinta%2Fspark%2Fissues%3Fq%3Dis%253Aopen%2Blabel%253Autil%2Blabel%253Acli)
+![NPM](https://img.shields.io/npm/l/%40spark-ui%2Fcli-utils)
diff --git a/packages/utils/cli/package.json b/packages/utils/cli/package.json
@@ -25,7 +25,7 @@
     "category": "utils"
   },
   "bugs": {
-    "url": "https://github.com/adevinta/spark/issues?q=label%3Autility+label%3Acli"
+    "url": "https://github.com/adevinta/spark/issues?q=is%3Aopen+label%3Autility+label%3Acli"
   },
   "homepage": "https://sparkui.vercel.app",
   "license": "MIT",

diff --git a/packages/utils/cli/src/generate/templates/component/[LICENSE.md].js b/packages/utils/cli/src/generate/templates/component/[LICENSE.md].js
@@ -0,0 +1,22 @@
+export default () => `MIT License
+
+Copyright (c) Adevinta ASA.
+
+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.
+`
diff --git a/packages/utils/cli/src/generate/templates/component/[README.md].js b/packages/utils/cli/src/generate/templates/component/[README.md].js
@@ -0,0 +1,16 @@
+export default ({ name }) => `# ${name}
+> @spark-ui/${name}
+
+![storybook](https://img.shields.io/badge/storybook-black?logo=storybook&link=https%3A%2F%2Fsparkui.vercel.app%2F%3Fpath%3D%2Fdocs%2Fcomponents-${name
+  .split('-')
+  .join('')}--docs)
+![documentation](https://img.shields.io/badge/documentation-black?logo=googledocs&link=https%3A%2F%2Fsparkui-adv.vercel.app%2Fdocs%2Fcomponent%2F${name})
+![issue](https://img.shields.io/badge/report%20a%20bug-black?logo=openbugbounty&logoColor=red&link=https%3A%2F%2Fgithub.com%2Fadevinta%2Fspark%2Fissues%2Fnew%3F%26projects%3D4%26template%3Dbug-report.yml%26assignees%3D%26labels%3Dcomponent%2C${name})
+![npm](https://img.shields.io/npm/dt/%40spark-ui/${name}?logo=npm&labelColor=black&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2F%40spark-ui%2F${name})
+
+
+This package is part of the [\`@spark-ui\`](https://github.com/adevinta/spark) react-js user interface component library project.
+
+![Issues open](https://img.shields.io/github/issues-search/adevinta/spark?query=is%3Aopen%20label%3Acomponent%20label%3A${name}&logo=openbugbounty&logoColor=red&label=issues%20open&color=red&link=https%3A%2F%2Fgithub.com%2Fadevinta%2Fspark%2Fissues%3Fq%3Dis%253Aopen%2Blabel%253Acomponent%2Blabel%253A${name})
+![NPM](https://img.shields.io/npm/l/%40spark-ui%2F${name})
+`
diff --git a/packages/utils/cli/src/generate/templates/component/[package.json].js b/packages/utils/cli/src/generate/templates/component/[package.json].js
@@ -37,7 +37,7 @@ export default ({ name, description }) => `{
     "category": "components"
   },
   "bugs": {
-    "url": "https://github.com/adevinta/spark/issues?q=label%3Autility+label%3A${name}"
+    "url": "https://github.com/adevinta/spark/issues?q=is%3Aopen+label%3Autility+label%3A${name}"
   },
   "homepage": "https://sparkui.vercel.app",
   "license": "MIT"

diff --git a/packages/utils/cli/src/generate/templates/hook/[LICENSE.md].js b/packages/utils/cli/src/generate/templates/hook/[LICENSE.md].js
@@ -0,0 +1,22 @@
+export default () => `MIT License
+
+Copyright (c) Adevinta ASA.
+
+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.
+`
diff --git a/packages/utils/cli/src/generate/templates/hook/[README.md].js b/packages/utils/cli/src/generate/templates/hook/[README.md].js
@@ -0,0 +1,16 @@
+export default ({ name }) => `# ${name}
+> @spark-ui/${name}
+
+![storybook](https://img.shields.io/badge/storybook-black?logo=storybook&link=https%3A%2F%2Fsparkui.vercel.app%2F%3Fpath%3D%2Fdocs%2Fhooks-${name
+  .split('-')
+  .join('')}--docs)
+![documentation](https://img.shields.io/badge/documentation-black?logo=googledocs&link=https%3A%2F%2Fsparkui-adv.vercel.app%2Fdocs%2Fhook%2F${name})
+![issue](https://img.shields.io/badge/report%20a%20bug-black?logo=openbugbounty&logoColor=red&link=https%3A%2F%2Fgithub.com%2Fadevinta%2Fspark%2Fissues%2Fnew%3F%26projects%3D4%26template%3Dbug-report.yml%26assignees%3D%26labels%3Dhook%2C${name})
+![npm](https://img.shields.io/npm/dt/%40spark-ui/${name}?logo=npm&labelColor=black&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2F%40spark-ui%2F${name})
+
+
+This package is part of the [\`@spark-ui\`](https://github.com/adevinta/spark) react-js user interface component library project.
+
+![Issues open](https://img.shields.io/github/issues-search/adevinta/spark?query=is%3Aopen%20label%3Ahook%20label%3A${name}&logo=openbugbounty&logoColor=red&label=issues%20open&color=red&link=https%3A%2F%2Fgithub.com%2Fadevinta%2Fspark%2Fissues%3Fq%3Dis%253Aopen%2Blabel%253Ahook%2Blabel%253A${name})
+![NPM](https://img.shields.io/npm/l/%40spark-ui%2F${name})
+`
diff --git a/packages/utils/cli/src/generate/templates/hook/[package.json].js b/packages/utils/cli/src/generate/templates/hook/[package.json].js
@@ -34,7 +34,7 @@ export default ({ name, description }) => {
     "category": "hooks"
   },
   "bugs": {
-    "url": "https://github.com/adevinta/spark/issues?q=label%3Ahook+label%3A${name}"
+    "url": "https://github.com/adevinta/spark/issues?q=is%3Aopen+label%3Ahook+label%3A${name}"
   },
   "homepage": "https://sparkui.vercel.app",
   "license": "MIT"

diff --git a/packages/utils/cli/src/generate/templates/util/[LICENSE.md].js b/packages/utils/cli/src/generate/templates/util/[LICENSE.md].js
@@ -0,0 +1,22 @@
+export default () => `MIT License
+
+Copyright (c) Adevinta ASA.
+
+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.
+`
diff --git a/packages/utils/cli/src/generate/templates/util/[README.md].js b/packages/utils/cli/src/generate/templates/util/[README.md].js
@@ -0,0 +1,16 @@
+export default ({ name }) => `# ${name}
+> @spark-ui/${name}
+
+![storybook](https://img.shields.io/badge/storybook-black?logo=storybook&link=https%3A%2F%2Fsparkui.vercel.app%2F%3Fpath%3D%2Fdocs%2Futils-${name
+  .split('-')
+  .join('')}--docs)
+![documentation](https://img.shields.io/badge/documentation-black?logo=googledocs&link=https%3A%2F%2Fsparkui-adv.vercel.app%2Fdocs%2Futil%2F${name})
+![issue](https://img.shields.io/badge/report%20a%20bug-black?logo=openbugbounty&logoColor=red&link=https%3A%2F%2Fgithub.com%2Fadevinta%2Fspark%2Fissues%2Fnew%3F%26projects%3D4%26template%3Dbug-report.yml%26assignees%3D%26labels%3Dutil%2C${name})
+![npm](https://img.shields.io/npm/dt/%40spark-ui/${name}?logo=npm&labelColor=black&link=https%3A%2F%2Fwww.npmjs.com%2Fpackage%2F%40spark-ui%2F${name})
+
+
+This package is part of the [\`@spark-ui\`](https://github.com/adevinta/spark) react-js user interface component library project.
+
+![Issues open](https://img.shields.io/github/issues-search/adevinta/spark?query=is%3Aopen%20label%3Autil%20label%3A${name}&logo=openbugbounty&logoColor=red&label=issues%20open&color=red&link=https%3A%2F%2Fgithub.com%2Fadevinta%2Fspark%2Fissues%3Fq%3Dis%253Aopen%2Blabel%253Autil%2Blabel%253A${name})
+![NPM](https://img.shields.io/npm/l/%40spark-ui%2F${name})
+`
diff --git a/packages/utils/cli/src/generate/templates/util/[package.json].js b/packages/utils/cli/src/generate/templates/util/[package.json].js
@@ -26,7 +26,7 @@ export default ({ name, description }) => `{
     "category": "utils"
   },
   "bugs": {
-    "url": "https://github.com/adevinta/spark/issues?q=label%3Autility+label%3A${name}"
+    "url": "https://github.com/adevinta/spark/issues?q=is%3Aopen+label%3Autility+label%3A${name}"
   },
   "homepage": "https://sparkui.vercel.app",
   "license": "MIT"