sublime-cli

README

Sublime CLI

❄️ SB-CLI (WIP)

Sublime CLI is a tool to create a frontend workspace, libs or packages to distribute as npm or global scripts to use on your page or micro frontend architecture. It is based in vite to build your dists and also it create artifacts to publish on the Websublime cloud. Current we only support github actions. The monorepo is powered by TurboRepo.

Table of contents

• Installation
• Usage
• Specs

Installation

(Back to top)

Mandatory dependencies: NodeJS >= 16 and Yarn

The easiest way to get started is by copying and pasting the command below in your terminal:

curl -sf https://raw.githubusercontent.com/websublime/sublime-cli/main/install.sh | sh

Or

Download the suitable binary for your OS from the list here and install it. Make sure to make executable with chmod +x.

Don't forget this step

In your github repo you will need to setup the following secrets:

Parameter	Description
GH_TOKEN	Github token

This will be used on github actions to create npm deploys, artifacts uploads and releases.

For OSX you will need to allow it to be executed, because it is not signed as a trusted/signed user.

Usage

(Back to top)

CLI tool to manage monorepo packages.

Usage:
  sublime [flags]
  sublime [command]

Available Commands:
  action      Github action command
  completion  Generate the autocompletion script for the specified shell
  create      Create JS/TS packages
  help        Help about any command
  login       Login author on sublime cloud platform.
  register    Register author on sublime cloud platform.
  status      Status about workspace
  version     Print the version number of sublime
  workspace   Create a workspace.

Flags:
      --config string   Config file (default is .sublime.json).
  -h, --help            help for sublime
      --root string     Project working dir, default to current dir.

Use "sublime [command] --help" for more information about a command.

Important

After installation you will need to follow the next steps:

• Run command to register on the platform: sublime register
• After registered please confirm your registration sent by email
• Now go to websublime.dev login and create your organization. Your organization should correspond to the github organization name. (WIP)
• With your organization created please login thru the cli to create your local identity file: sublime login
• Congrats! You are now able to start creating workspaces on your new organization.

Create workspace

First let's start to create a workspace monorepo. The creation of the workspace will need some parameters to fullfill package.json needs.

> sublime workspace --organization websublime

The organization should be the github organization name, because artifacts will be release to github and you be able to install it via npm. The CLI will prompt you with questions to be answer. All are mandatory.

After created, your workspace will be ready to create packages inside of it.

Create package/lib

Creating a library or package. Monorepo has two folders where you can create your packages they are: libs and packages. Packages on libs are designed to be common features to other packages use. You will see that by default one lib is present. This lib is a vite plugin that provide automatic namespace resolution between packages/libs. The CLI will prompt you with questions to be answer. All are mandatory

> sublime create

Packages are created from templates. The templates current supported are: lit, solid, vue and typescript. Maybe in the future will be incremented.

Default template is: typescript

Global parameters, can be used with any command before calling the command itself. There are two global parameters:

Parameter	Description
--root	The root folder of your workspace
--config	The .sublime.json config file

> sublime --root ./sublime-ui create

If you run the cli from inside your workspace folder this parameters are resolved automatic.

Github action

Predefined actions were created when you created an workspace. This actions will trigger based on:

• Branch name as: feat/...
• Tag creation
• Snapshot

Also there one release that will put as npm package on github to be consume as that if you need.

To create a snapshot, create a branch releases/snapshots and just follow the step of yarn changesets. The pipeline will create an artifact with next version and sufixed with snapshot for testing purposes (v1.0.0-SNAPSHOT).

Parameter	Description
--type	Type is: branch or tag making the diference for prod or dev
--env	Environment in which you are right now (dev, prod)

Important

You can adjust your workflows if needeed but be aware that changing the predefined action where it runs sublime action command can break your deploysto the websublime cloud. Actions also are based on the package changeset. They are already configured. Please follow the link to know more about it. All your branchs should follow that guideline to create awesome changelogs/issues and independent packages versions.

Contributing

(Back to top)

Your contributions are always welcome! Please have a look at the contribution guidelines first. 🎉

Create branch, work on it and before submit run:

• git add .
• git commit -m "feat: title" -m "Description"
• git add .
• git commit --amend
• git push origin feat/... -f

License

(Back to top)

The MIT License (MIT) 2022 - Websublime. Please have a look at the LICENSE.md for more details.

Documentation

Overview

Copyright © 2022 Websublime.dev organization@websublime.dev

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.