Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Cli cleanup #2375

Merged
merged 3 commits into from
Mar 18, 2022
Merged

chore: Cli cleanup #2375

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1dfd46b
Use remix-dev directly in create-remix
mjackson Mar 18, 2022
123251e
Merge branch 'dev' into cli-cleanup
chaance Mar 18, 2022
155b181
chore: update remix dev to latest
chaance Mar 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 3 additions & 22 deletions packages/create-remix/cli.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,29 +1,10 @@
import { execSync } from "child_process";
import shellEscape from "shell-escape";
import { cli } from "@remix-run/dev";

import packageJson from "./package.json";

async function run() {
console.log("💿 Welcome to Remix! Let's get you set up with a new project.");
console.log();

let args = process.argv.slice(2);
let escapedArgs = shellEscape(args);

let npxVersion = execSync(`npx --version`).toString().trim();
let flag = Number(npxVersion[0]) > 6 ? "--yes" : "";

execSync(
`npx ${flag} @remix-run/dev@${packageJson.version} create ${escapedArgs}`,
{ stdio: "inherit" }
);
}

run().then(
cli.run().then(
() => {
process.exit(0);
},
(error: unknown) => {
(error: Error) => {
console.error(error);
process.exit(1);
}
Expand Down
5 changes: 1 addition & 4 deletions packages/create-remix/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,6 @@
"create-remix": "cli.js"
},
"dependencies": {
"shell-escape": "^0.2.0"
},
"devDependencies": {
"@types/shell-escape": "^0.2.0"
"@remix-run/dev": "1.3.2"
}
}
3 changes: 2 additions & 1 deletion packages/create-remix/tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
{
"exclude": ["__tests__", "templates"],
"compilerOptions": {
"lib": ["ES2019"],
"target": "ES2019",
"module": "CommonJS",
"skipLibCheck": true,

"moduleResolution": "node",
"allowSyntheticDefaultImports": true,
Expand Down
322 changes: 3 additions & 319 deletions packages/remix-dev/cli.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,326 +1,10 @@
import * as path from "path";
import meow from "meow";
import inspector from "inspector";
import inquirer from "inquirer";
// import chalkAnimation from "chalk-animation";
import { cli } from "./index";

import * as colors from "./colors";
import * as commands from "./cli/commands";
import packageJson from "./package.json";

const remixDevPackageVersion = packageJson.version;

const helpText = `
${colors.logoBlue("R")} ${colors.logoGreen("E")} ${colors.logoYellow(
"M"
)} ${colors.logoPink("I")} ${colors.logoRed("X")}

${colors.heading("Usage")}:
$ remix create <${colors.arg("projectDir")}> --template <${colors.arg(
"template"
)}>
$ remix init [${colors.arg("projectDir")}]
$ remix build [${colors.arg("projectDir")}]
$ remix dev [${colors.arg("projectDir")}]
$ remix routes [${colors.arg("projectDir")}]
$ remix setup [${colors.arg("remixPlatform")}]

${colors.heading("Options")}:
--help, -h Print this help message and exit
--version, -v Print the CLI version and exit
--no-color Disable ANSI colors in console output
\`create\` Options:
--template The template to use (required)
--no-install Skip installing dependencies after creation
--no-typescript Convert the template to JavaScript
--remix-version The version of Remix to use
\`build\` Options:
--sourcemap Generate source maps for production
\`dev\` Options:
--debug Attach Node.js inspector
\`routes\` Options:
--json Print the routes as JSON

${colors.heading("Values")}:
- ${colors.arg("projectDir")} The Remix project directory
- ${colors.arg("template")} The project template to use
- ${colors.arg(
"remixPlatform"
)} node, cloudflare-pages, or cloudflare-workers

${colors.heading("Creating a new project")}:

Remix projects are created from templates. A template can be:

- a file path to a directory of files
- a file path to a tarball
- the name of a repo in the remix-run GitHub org
- the name of a username/repo on GitHub
- the URL of a tarball

$ remix create my-app --template /path/to/remix-template
$ remix create my-app --template /path/to/remix-template.tar.gz
$ remix create my-app --template [remix-run/]grunge-stack
$ remix create my-app --template github-username/repo-name
$ remix create my-app --template https://github.com/:username/:repo
$ remix create my-app --template https://github.com/:username/:repo/tree/:branch
$ remix create my-app --template https://github.com/:username/:repo/archive/refs/tags/:tag.tar.gz
$ remix create my-app --template https://example.com/remix-template.tar.gz

To create a new project from a template in a private GitHub repo,
set the \`GITHUB_TOKEN\` environment variable to a personal access
token with access to that repo.

${colors.heading("Initialize a project:")}:

Remix project templates may contain a \`remix.init\` directory
with a script that initializes the project. This script automatically
runs during \`remix create\`, but if you ever need to run it manually
(e.g. to test it out) you can:

$ remix init

${colors.heading("Build your project")}:

$ remix build
$ remix build --sourcemap
$ remix build my-app

${colors.heading("Run your project locally in development")}:

$ remix dev
$ remix dev my-app
$ remix dev --debug

${colors.heading("Show all routes in your app")}:

$ remix routes
$ remix routes my-app
$ remix routes --json
`;

async function run() {
let { flags, input, showHelp, showVersion } = meow(helpText, {
description: false,
booleanDefault: undefined,
flags: {
help: { type: "boolean", alias: "h" },
version: { type: "boolean", alias: "v" },
template: { type: "string" },
install: { type: "boolean" },
typescript: { type: "boolean" },
remixVersion: { type: "string", default: remixDevPackageVersion },
json: { type: "boolean" },
sourcemap: { type: "boolean" },
debug: { type: "boolean" },
},
});

if (flags.help) showHelp();
if (flags.version) showVersion();

// if (!flags.template) {
// if (colors.supportsColor && process.env.NODE_ENV !== "test") {
// let anim = chalkAnimation.rainbow(
// `\nR E M I X - v${remixDevPackageVersion}\n`
// );
// await new Promise((res) => setTimeout(res, 1500));
// anim.stop();
// }
// }

switch (input[0]) {
case "create":
// `remix new` is an alias for `remix create`
case "new": {
let projectPath =
input.length > 1
? input[1]
: (
await inquirer
.prompt<{ dir: string }>([
{
type: "input",
name: "dir",
message: "Where would you like to create your app?",
default: "./my-remix-app",
},
])
.catch((error) => {
if (error.isTtyError) {
showHelp();
return;
}
throw error;
})
)?.dir;

if (!projectPath) {
showHelp();
return;
}

let projectDir = path.resolve(process.cwd(), projectPath);

let answers = await inquirer
.prompt<{
appType: "template" | "stack";
appTemplate: string;
useTypeScript: boolean;
install: boolean;
}>([
{
name: "appType",
type: "list",
message: "What type of app do you want to create?",
when() {
return flags.template === undefined;
},
choices: [
{
name: "A pre-configured stack ready for production",
value: "stack",
},
{
name: "Just the basics",
value: "template",
},
],
},
{
name: "appTemplate",
type: "list",
when(answers) {
return answers.appType === "stack";
},
message: "Which Stack do you want? ",
loop: false,
suffix: "(Learn more about these stacks: https://remix.run/stacks)",
choices: [
{
name: "Blues",
value: "blues-stack",
},
{
name: "Indie",
value: "indie-stack",
},
{
name: "Grunge",
value: "grunge-stack",
},
],
},
{
name: "appTemplate",
type: "list",
when(answers) {
return answers.appType === "template";
},
message: `Where do you want to deploy? Choose Remix if you're unsure, it's easy to change deployment targets.`,
loop: false,
choices: [
{ name: "Remix App Server", value: "remix" },
{ name: "Express Server", value: "express" },
{ name: "Architect (AWS Lambda)", value: "arc" },
{ name: "Fly.io", value: "fly" },
{ name: "Netlify", value: "netlify" },
{ name: "Vercel", value: "vercel" },
{ name: "Cloudflare Pages", value: "cloudflare-pages" },
{ name: "Cloudflare Workers", value: "cloudflare-workers" },
],
},
{
name: "useTypeScript",
type: "list",
message: "TypeScript or JavaScript?",
when(answers) {
return (
flags.template === undefined && answers.appType !== "stack"
);
},
choices: [
{ name: "TypeScript", value: true },
{ name: "JavaScript", value: false },
],
},
{
name: "install",
type: "confirm",
message: "Do you want me to run `npm install`?",
when() {
return flags.install === undefined;
},
default: true,
},
])
.catch((error) => {
if (error.isTtyError) {
console.warn(
colors.warning(
"🚨 Your terminal doesn't support interactivity; using default configuration.\n\n" +
"If you'd like to use different settings, try passing them as arguments. Run " +
"`npx create-remix@latest --help` to see available options."
)
);
return {
appTemplate: "remix",
useTypeScript: true,
install: true,
};
}
throw error;
});

await commands.create({
appTemplate: flags.template ?? answers.appTemplate,
projectDir,
remixVersion: flags.remixVersion,
installDeps: flags.install ?? answers.install,
useTypeScript: flags.typescript ?? answers.useTypeScript,
githubToken: process.env.GITHUB_TOKEN,
});
break;
}
case "init": {
let remixRoot = input[1];
if (!remixRoot) {
remixRoot = process.env.REMIX_ROOT || process.cwd();
}
await commands.init(remixRoot);
break;
}
case "routes":
await commands.routes(input[1], flags.json ? "json" : "jsx");
break;
case "build":
if (!process.env.NODE_ENV) process.env.NODE_ENV = "production";
await commands.build(input[1], process.env.NODE_ENV, flags.sourcemap);
break;
case "watch":
if (!process.env.NODE_ENV) process.env.NODE_ENV = "development";
await commands.watch(input[1], process.env.NODE_ENV);
break;
case "setup":
await commands.setup(input[1]);
break;
case "dev":
if (!process.env.NODE_ENV) process.env.NODE_ENV = "development";
if (flags.debug) inspector.open();
await commands.dev(input[1], process.env.NODE_ENV);
break;
default:
// `remix ./my-project` is shorthand for `remix dev ./my-project`
if (!process.env.NODE_ENV) process.env.NODE_ENV = "development";
await commands.dev(input[0], process.env.NODE_ENV);
}
}

run().then(
cli.run().then(
() => {
process.exit(0);
},
(error) => {
(error: Error) => {
console.error(error);
process.exit(1);
}
Expand Down
Loading