Release/cli/3.0.20 (#119)

* docs: remove unused pages; minor tweaks (#118) * fix(CLI): ensure component lib CLI outputs correct instructions (#116) * fix(CLI templates): update project readme with correct local dev command (#117) * fix(CLI templates): remove opinions from base component (#115) * build: CLI 3.0.20
wethegit · Mar 28, 2024 · a4add5a · a4add5a
1 parent 80d6dd8
commit a4add5a
Show file tree

Hide file tree

Showing 21 changed files with 24 additions and 383 deletions.
diff --git a/cli/lib/print-next-steps.js b/cli/lib/print-next-steps.js
@@ -12,7 +12,7 @@ const printNextSteps = (dir, componentsList) => {
   )} \n- npm install`
 
   if (componentsList.length) {
-    logMessage += ` \n\n🧩 Looks like this template requires components from ${chalk.bold("@wethegit/component-library")}. \nAfter installing dependencies run: \n- npx components-cli init \n- npx components-cli add ${componentsList.join(' ')}\n`
+    logMessage += ` \n\n🧩 Looks like this template requires components from ${chalk.bold("@wethegit/component-library")}. \nAfter installing dependencies run: \n- npx @wethegit/components-cli init \n- npx @wethegit/components-cli add ${componentsList.join(' ')}\n`
   }
 
   logMessage += `\n- npm start`;

diff --git a/cli/package.json b/cli/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@wethegit/corgi",
-  "version": "3.0.19",
+  "version": "3.0.20",
   "description": "Command line interface for use with the corgi framework.",
   "main": "bin/index.js",
   "bin": {

diff --git a/cli/templates/component/component.jsx b/cli/templates/component/component.jsx
@@ -1,15 +1,12 @@
 import { useEffect, useState } from "react"
 
 import { useLocale } from "@local/hooks"
-import { classnames } from "@local/utilities"
 
-import styles from "./COMPONENT_SLUG.module.scss"
-
-export function COMPONENT_NAME({ className, ...props }) {
+export function COMPONENT_NAME({ ...props }) {
   const { globals, page } = useLocale()
 
   return (
-    <div className={classnames([styles.wrap, className])} {...props}>
+    <div {...props}>
       <code>COMPONENT_NAME</code>!
     </div>
   )

diff --git a/cli/templates/component/component.module.scss b/cli/templates/component/component.module.scss
diff --git a/cli/templates/project/README.md b/cli/templates/project/README.md
@@ -8,7 +8,7 @@ Check out the official [corgi documentation](https://wethegit.github.io/corgi/)
 ```bash
 nvm use
 npm install
-npm run dev
+npm start
 ```
 
 ## Build for production

diff --git a/docs/docs/hooks/use-async.mdx b/docs/docs/hooks/use-async.mdx
diff --git a/docs/docs/hooks/use-breakpoints.mdx b/docs/docs/hooks/use-breakpoints.mdx
diff --git a/docs/docs/hooks/use-local-storage.mdx b/docs/docs/hooks/use-local-storage.mdx
diff --git a/docs/docs/hooks/use-prevent-scroll.mdx b/docs/docs/hooks/use-prevent-scroll.mdx
diff --git a/docs/docs/hooks/use-user-prefs.mdx b/docs/docs/hooks/use-user-prefs.mdx
diff --git a/docs/docs/quick-start/create-a-project.mdx b/docs/docs/quick-start/create-a-project.mdx
@@ -24,10 +24,15 @@ cd my-web-app
 npm install
 ```
 
+To build the project locally and watch for changes, run:
+```base
+npm start
+```
+
 🎉 **That's it! You're ready to start building your web app.**
 
 :::caution Node.JS & NVM
-corgi requires **[Node.js](https://nodejs.org/en/) version 16 or greater**. If you use `nvm`, run the following before installing dependencies:
+corgi requires **[Node.js](https://nodejs.org/en/) version 20 or greater**. If you use `nvm`, run the following before installing dependencies:
 
 ```bash
 nvm use

diff --git a/docs/docs/styles.md b/docs/docs/styles.md
@@ -0,0 +1,9 @@
+---
+id: styles
+title: Styles
+position: 6
+---
+
+# Styles
+
+Out-of-the-box, corgi does not enforce any CSS opinions. Check out the [Next JS documentation](https://nextjs.org/docs/app/building-your-application/styling) for more information on adding styles. 
diff --git a/docs/docs/styles/_category_.json b/docs/docs/styles/_category_.json
diff --git a/docs/docs/styles/component-styles.mdx b/docs/docs/styles/component-styles.mdx
diff --git a/docs/docs/styles/global-styles.mdx b/docs/docs/styles/global-styles.mdx
diff --git a/docs/docs/styles/grid-system.mdx b/docs/docs/styles/grid-system.mdx