refactor: Extracting project creation out to own package #1708

rschristian · 2022-07-08T09:36:47Z

What kind of change does this PR introduce?

Rather large refactor

Did you add tests for your changes?

Existing cover

Summary

Creating new projects with our recommended method (npx preact-cli create ...) is painfully slow due to every dependency needing to be downloaded for minimal functionality. We can improve this by extracting out project creation to its own package, allowing us to cut the dependency count down dramatically. This will allow users to much more quickly initialize projects.

I have cut back on functionally offered by a fair bit, as much of our project creation is unused by us and I think goes beyond what we really need to offer.

Removed the interactive prompt if a user doesn't provide a template & destination
- An interactive prompt just to handle this seems like a bit overkill. Sure, we do then also walk the user through the various flags, but I think the CLI is simple enough where this isn't necessary.
No longer do we do templating on project initialization
- Previously we had a handful of values that would be replaced if found in the templates, such as {{ name }}, {{ license }}, etc. ref
- We only make use of {{ name }} in our own templates, and I doubt many users with custom templates know there are more values that can be used.
- I don't think we need to offer this functionality out-of-the-box. These are things that users can easily add in themselves if they need them.

Does this PR introduce a breaking change?

Yes, users will need to use a new package in their project init command.

Additionally, the --yarn flag has been removed. If our package is named like create-<pkg>, we can allow users to instead use npm init <pkg> or yarn create <pkg. From their initialization command we can determine the package manager to use instead of relying on flags.

changeset-bot · 2022-07-08T09:36:50Z

🦋 Changeset detected

Latest commit: 0791118

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 2 packages

Name	Type
preact-cli	Major
create-preact-cli	Major

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

* refactor: Extracting out project creation to own package * docs: Adding changeset * refactor: Misc edits to common deps & workspace helper scripts * test: Fixing 'create' test suite * ci: Increase minimum Node version * chore: Fix typos * docs: Update ReadMe instructions * chore: Better (and untaken) package name * docs: Update changeset * test: Update 'create' test suite & build output hashes * docs: Expounding upon changeset

* fix: Corrections for #1708 being merged too early * test: Fix import path * style: Strip file extensions from imports for consistency

* refactor: Extracting out project creation to own package * docs: Adding changeset * refactor: Misc edits to common deps & workspace helper scripts * test: Fixing 'create' test suite * ci: Increase minimum Node version * chore: Fix typos * docs: Update ReadMe instructions * chore: Better (and untaken) package name * docs: Update changeset * test: Update 'create' test suite & build output hashes * docs: Expounding upon changeset

* fix: Corrections for #1708 being merged too early * test: Fix import path * style: Strip file extensions from imports for consistency

* refactor: Extracting out project creation to own package * docs: Adding changeset * refactor: Misc edits to common deps & workspace helper scripts * test: Fixing 'create' test suite * ci: Increase minimum Node version * chore: Fix typos * docs: Update ReadMe instructions * chore: Better (and untaken) package name * docs: Update changeset * test: Update 'create' test suite & build output hashes * docs: Expounding upon changeset

* Chore: Updating html-webpack-plugin to v4 (#1608) * chore: Correcting changeset * feat: webpack v5 (#1645) * feat: webpack-v5 * test: Update tests * docs: Updating docs to reflect changes * chore: Removing optimize-plugin local patch * refactor: Determine CSS module by filename, not directory (#1714) * refactor: Determine CSS module by filename, not directory * docs: Adding changeset * refactor: Project creation pull from templates 'main' branch * test: Updating tests * revert: Accidentally removed log message * refactor: Extracting project creation out to own package (#1708) * refactor: Extracting out project creation to own package * docs: Adding changeset * refactor: Misc edits to common deps & workspace helper scripts * test: Fixing 'create' test suite * ci: Increase minimum Node version * chore: Fix typos * docs: Update ReadMe instructions * chore: Better (and untaken) package name * docs: Update changeset * test: Update 'create' test suite & build output hashes * docs: Expounding upon changeset * refactor: Drop Preact 8 support (#1716) * refactor: Drops support for Preact v8 * docs: Adding changeset * refactor: Switch to automatic runtime JSX transform (#1725) * refactor: Switch over to automatic runtime transform for JSX * test: Removing `h` imports from test suite * docs: Adding changeset * docs: Adding readme for create-cli (#1728) * docs: Adding readme for create-cli * feat: Initial publish * fix: Correcting broken readme links * refactor: Disable hashing ssr-build's css (#1733) * refactor: Disable hashing ssr-build's css * docs: Adding changeset * test: Fix unrelated change from altered template * refactor: Remove `--preload` flag (#1737) * refactor: Removes `--preload` flag & functionality * docs: Adding changeset * docs: Updating readme for removal of preload * refactor: Separate internal concepts of config and env (#1734) * refactor: Separate internal concepts of config and env * docs: Adding changeset * refactor: prune flags (#1752) * refactor: Revise inconsistent, unused, and deprecated flags * docs: Adding changeset * feat: Improved errors and warnings (#1758) * refactor: Better root error handling * refactor: Switch prerender plugin to be async for error gen * refactor: Simplify & improve compilation messages * refactor: Bump Node version, remove `src` arg in build & watch, and misc housekeeping (#1753) * refactor: Drop rimraf for built-in fs.rm * refactor: Drop src argument in build & watch cmds * refactor: Extract info cmd from CLI entrypoint * refactor: Remove update-notifier * refactor: Switch from fs.promises to fs/promises * docs: Adding changeset * refactor: Move EJS into user templates (`template.html`) (#1768) * refactor: Merging EJS templates and switcing preferred template extension to .ejs * test: Fixing test suite to reflect latest changes * chore: Cleaning * docs: Updating ReadMe * docs: Adding changeset * refactor: Add error message for <% preact.(head|body)End %> * chore: Publishing cli & create-cli * Refactor: Enable Prefresh by Default (#1772) * refactor: Enables HMR via Prefresh by default * docs: Adding changeset * test: Updating tests to reflect changes to templates * refactor: Remove Critters (perhaps temporarily) (#1778) * refactor: Remove Critters (perhaps temporarily) * docs: Adding changeset * chore: Publish v4.0.0-next.2 * refactor: Vendor Critters so that 7c811ac can be reverted (#1780) * docs: Remove CLI beta note from readme * docs: Bump minimum Node version listed in readme

rschristian force-pushed the refactor/extract-create-command branch 2 times, most recently from 9441660 to 11c4a2c Compare July 8, 2022 11:48

rschristian force-pushed the refactor/extract-create-command branch 2 times, most recently from 2dd3636 to 5a69415 Compare July 16, 2022 10:02

rschristian added 9 commits July 24, 2022 22:02

refactor: Extracting out project creation to own package

c654ab3

docs: Adding changeset

7aae774

refactor: Misc edits to common deps & workspace helper scripts

f58a7b7

test: Fixing 'create' test suite

5e71ade

ci: Increase minimum Node version

d54469b

chore: Fix typos

41c8ac1

docs: Update ReadMe instructions

1485a49

chore: Better (and untaken) package name

ef2ebed

docs: Update changeset

e0c4de0

rschristian force-pushed the refactor/extract-create-command branch 3 times, most recently from 6c3b7d9 to 80364d4 Compare July 25, 2022 03:14

test: Update 'create' test suite & build output hashes

7f85c2d

rschristian force-pushed the refactor/extract-create-command branch from 80364d4 to 7f85c2d Compare July 25, 2022 03:34

docs: Expounding upon changeset

0791118

rschristian marked this pull request as ready for review July 25, 2022 04:05

rschristian requested a review from a team as a code owner July 25, 2022 04:05

rschristian merged commit 5e65318 into next Jul 25, 2022

rschristian deleted the refactor/extract-create-command branch July 25, 2022 04:05

rschristian added a commit that referenced this pull request Aug 4, 2022

fix: Corrections for #1708 being merged too early

0c3b31c

rschristian added a commit that referenced this pull request Aug 4, 2022

fix: Corrections for #1708 being merged too early (#1724)

2b958cd

* fix: Corrections for #1708 being merged too early * test: Fix import path * style: Strip file extensions from imports for consistency

rschristian added a commit that referenced this pull request Aug 13, 2022

fix: Corrections for #1708 being merged too early (#1724)

1797d9e

* fix: Corrections for #1708 being merged too early * test: Fix import path * style: Strip file extensions from imports for consistency

rschristian added a commit that referenced this pull request Aug 18, 2022

fix: Corrections for #1708 being merged too early (#1724)

aa0db12

* fix: Corrections for #1708 being merged too early * test: Fix import path * style: Strip file extensions from imports for consistency

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: Extracting project creation out to own package #1708

refactor: Extracting project creation out to own package #1708

rschristian commented Jul 8, 2022 •

edited

Loading

changeset-bot bot commented Jul 8, 2022 •

edited

Loading

refactor: Extracting project creation out to own package #1708

refactor: Extracting project creation out to own package #1708

Conversation

rschristian commented Jul 8, 2022 • edited Loading

What kind of change does this PR introduce?

Did you add tests for your changes?

Summary

Does this PR introduce a breaking change?

changeset-bot bot commented Jul 8, 2022 • edited Loading

🦋 Changeset detected

rschristian commented Jul 8, 2022 •

edited

Loading

changeset-bot bot commented Jul 8, 2022 •

edited

Loading