Skip to content

Latest commit

 

History

History
66 lines (55 loc) · 2.39 KB

README.md

File metadata and controls

66 lines (55 loc) · 2.39 KB

Solid CLI

Warning

This project is under heavy development and is not yet complete. More features coming soon!

Solid CLI

Build and Test Netlify Status

A custom-built CLI for creating and managing SolidJS apps and projects.

Roadmap/Features

  • Templates
    • From Degit
  • Docs
  • Primitives
    • Add/remove/update primitives
    • Search list of primitives
  • Integrations
    • Auth.js
    • Tailwind
    • PandaCSS
    • Cypress
    • PostCSS
    • UnoCSS
    • Vanilla Extract
    • Vitest
    • Tauri
    • Playwright
  • Utilities
    • eslint-plugin-solid
    • solid-devtools
  • Misc
    • Launch new Stackblitz
    • Launch new CodeSandBox
  • SolidStart
    • New route
    • New data file
    • Enable Adapters
    • Enable SSR/CSR/SSG mode

Structure

The CLI is invoked with solid. The commands then cascade, where actions are grouped with other similar actions. The actions will be:

  • version: Displays a changelog of recent Solid versions
    • start: Specific command for Start versions
  • docs: List a man-like page for versioned docs or link out to the docs
  • primitives: Potential integration with Solid Primitives
  • add, remove: Used for adding and installing integrations/packages ie. solid add tailwind
  • config: For enabling a certain features ie. solid config vite _____
  • start: Special keyword for SolidStart commands
    • mode: Changes the Start serving mode (ssr/csr/ssg) solid mode ssr
    • route: Creates a new route ie. solid start route login
  • new: Opens your browser to a new template via CSB/SB ie. solid new bare --stackblitz opens https://solid.new/bare
  • ecosystem
    • add: Starts the process of submitting your current project to our ecosystem listing (Solidex) ie. solid ecosystem publish
    • search: Initializes an ecosystem search result solid ecosystem search auth

Contributing

Please feel free to contribute to this repo by creating an issue or a PR.