rescript-lang / create-rescript-app Goto Github PK

Hi @mahezsh,

We will be removing the built-in templates ("rescript init") from the ReScript compiler in version 11 as they are completely outdated, see rescript-lang/rescript-compiler#5682.

We would like to keep such functionality (creation of new projects from templates) decoupled from the compiler in the future.

I like the simple approach taken in your create-rescript-app project. Would it be possible to transfer it to the rescript-lang organization so that we can continue maintaining it there, and also give the ReScript team access to the create-rescript-app npm package?

Currently (as of v1.4.0) providing these two:

• Basic: https://github.com/rescript-lang/rescript-project-template.git
• Next.js: https://github.com/ryyppy/rescript-nextjs-template.git

What other templates could/should we provide (while not going overboard with this and still keeping things minimalistic)?

How/where should the templates be stored to enforce consistency and avoid breakage?

Should we provide "experimental" templates for trying out things like JSX4?

I've cloned an empty project from github, containing only readme and licence. Running npm init rescript-app created a nested directory. In this case I'd like to have an option to put everything in the current directory.

This is quite problematic, which might cause someone to accidentally include node_modules into git repo.

Works:

yarn create rescript-app my-app -b

Does not work:

yarn create rescript-app my-app --basic

$ bun create rescript-app

Error: Command failed: npm view rescript versions --json
│  'npm' is not recognized as an internal or external command,
│  operable program or batch file.
│
│
└  Project creation failed.

■  Canceled

This is a command directly from the website...

When using create-rescript-app 1.7.1 (and picking the basic template + ReScript 11.1.1 + ReScript 1.4.0), the rescript.json file created for a new project looks like this:

{
  // …
  "package-specs": {
    "module": "esmodule",
    "in-source": true
  },
  "suffix": ".res.js",
  // …
}

Thus, building the project and running node src/Demo.res.js will lead to Node.js complaining about a syntax error (“Unexpected token 'export'”).

Of the 5 templates

basicRepo = "https://github.com/rescript-lang/rescript-project-template.git"
defaultRepo = "https://github.com/mahezsh/rescript-template-default.git"
nextJsRepo = "https://github.com/ryyppy/rescript-nextjs-template.git"
graphqlRepo = "https://github.com/mahezsh/rescript-template-graphql.git"
sbRepo = "https://github.com/mahezsh/rescript-template-storybook.git"

only basic and nextJs are currently working.

@mahezsh What happened to the three templates under https://github.com/mahezsh?

This could be a neat thing - configure gentype automatically whenever adding to an existing project with TS already installed.

We could:

• Detect the config needed for "module" and "moduleResolution" in gentype via tsconfig.json
• Warn of allowJs is not true in tsconfig.json and explain why it's needed

Going for a "1 command to get setup" approach.

cc @cometkim

If you decide to write the project in ReScript you can find the inquirer bindings useful https://github.com/Nicolas1st/net-cli-rock-paper-scissors/blob/main/apps/client/src/UI.res