feat(cli): Add shortest init command
#297
Conversation
… the lib in a fresh repo
|
@khalatevarun is attempting to deploy a commit to the Antiwork Team on Vercel. A member of the Team first needs to authorize it. |
|
Should update the README too |
…b to detect package manager
rmarescu
changed the title
shortest init command to setup library in a fresh repo with config filesshortest init command
|
nit: I think the purpose of the util folder is to store files that are frequently reused throughout the project. since most of the functions are not reused, they don't belong there. while I would suggest inlining them |
khalatevarun
changed the title
shortest init commandshortest init command
|
the changes seem to be working fine when the package is built locally and used in another project |
|
open to any additional reviews - @gladyshcodes @rmarescu |
|
I've started reviewing, will wrap up tomorrow! |
|
thank you for the review and code changes, learning alot in the process @rmarescu |
There was a problem hiding this comment.
Tested on a empty folder, and on a fresh Next.js install, seems to be working fine. Thanks for the contribution @khalatevarun!
| @@ -24,18 +24,20 @@ If helpful, [here's a short video](https://github.com/anti-work/shortest/issues/ | |||
|
|
|||
| ### Installation | |||
|
|
|||
| ```bash | |||
There was a problem hiding this comment.
Manual instructions can be removed. The description below outlines the steps, in case someone would like to do it manually.
| @@ -111,6 +111,11 @@ function isValidArg(arg: string): boolean { | |||
| async function main() { | |||
| const args = process.argv.slice(2); | |||
|
|
|||
| if (args[0] === "init") { | |||
| await require("../commands/init").default(); | |||
There was a problem hiding this comment.
Extracted all the logic to its own module.
| import { addToGitignore } from "../../utils/add-to-gitignore"; | ||
|
|
||
| export default async function main() { | ||
| console.log(pc.blue("Setting up Shortest...")); |
There was a problem hiding this comment.
blue doesn't look great on a dark terminal. We should consider improving the contrast at some point.
| packageJson?.devDependencies?.["@antiwork/shortest"] | ||
| ) { | ||
| console.log(pc.green("✔ Package already installed")); | ||
| return; |
There was a problem hiding this comment.
Important to exit early if the package is already installed, otherwise there would be some considerable effort to ensure the install doesn't overwrite any existing data.
| const configPath = join(process.cwd(), CONFIG_FILENAME); | ||
| const exampleConfigPath = join( | ||
| fileURLToPath(new URL("../../src", import.meta.url)), | ||
| `${CONFIG_FILENAME}.example`, |
There was a problem hiding this comment.
Simplified the logic to use an example file.
| console.log(pc.green(`✔ ${CONFIG_FILENAME} created`)); | ||
|
|
||
| const envResult = await addToEnv(process.cwd(), { | ||
| ANTHROPIC_API_KEY: { |
There was a problem hiding this comment.
I don't think it's worth adding Mailosaur at this time, although other ENVs can be easily added in the future.
| } | ||
|
|
||
| const resultGitignore = await addToGitignore(process.cwd(), [ | ||
| ".env*.local", |
There was a problem hiding this comment.
Not worth the effort trying to group with other env*-like values already present (e.g. .env from a fresh Next.js install).
Resolves #294