-
Notifications
You must be signed in to change notification settings - Fork 24
Open
Labels
featurefeature or requestfeature or request
Description
📋 Description
Today, vlt init does very little when it should be helping you out a lot more. We should be...
- consolidate
vlt init&vlt createcommands (likenpmhas historically...) - add a wizard experience when
--yesisn't set & we aren't trying to use a template package (ie.vlt create react-app) with some of the following prompts... - package.json:
- set
private(the question should be something like "is this a public package" ie. we'll set theprivatevalue to"true"if "no" but if "yes" then we don't set this at all)] nameof the package (default to inferred folder name we already create)version(default to0.0.1)description(default to "")- entry point/
main(default to "index.js") - set the
authorinformation - name/email (based on input, default to environment's git author/email config) - create set
license(based on input, default should be MIT) & create a license file with the corresponding text - set
type(default to "module" but option for "commonjs" / blank) - set
browser(if the project is intended to be a browser-based distro, default to no/not setting this) - set
devEngines.runtime(default nothing): as user aboutnode,bun,deno - set
devEngines.packageManagerto relevant version ofvlt(ex.^1) - set
vlt& installvltas adevDependency
- set
- create an
AGENTS.mdfile in your project explainingvlt& the type of project this is (ex. https://agents.md/) - create a
.gitignorefor a basic node modules project (ex. excludingnode_modulesfolder) - run
git initin the project/folder - run
vlt installso thatnode_modules& the lockfile/hidden lockfile are generated - create
vlt.jsonwith basic keys stubbed out but ready to be used
Considerations
- check to see if these files/setup doesn't already exist (ex. we may be running create/init in a workspace/to scaffold workspaces - may still be good to run
vlt installafter the workspace is created though so that the lockfile & hidden lockfile stay up to date)
🔍 Research & Prior Art
- anecdotally, more tools are scaffolding more things when starting a new project with that tool
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
featurefeature or requestfeature or request