Skip to content

Scripts: Remove legacy env scripts and packages.#22953

Merged
epiqueras merged 4 commits intomasterfrom
remove/legacy-env
Jun 7, 2020
Merged

Scripts: Remove legacy env scripts and packages.#22953
epiqueras merged 4 commits intomasterfrom
remove/legacy-env

Conversation

@epiqueras
Copy link
Copy Markdown
Contributor

This PR removes the deprecated and now unused env family of scripts and updates the relevant documentation.

@epiqueras epiqueras added [Type] Breaking Change For PRs that introduce a change that will break existing functionality [Tool] WP Scripts /packages/scripts labels Jun 5, 2020
@epiqueras epiqueras self-assigned this Jun 5, 2020
@github-actions
Copy link
Copy Markdown

github-actions bot commented Jun 5, 2020

Size Change: +171 B (0%)

Total Size: 1.12 MB

Filename Size Change
build/block-library/index.js 127 kB +170 B (0%)
build/components/index.js 193 kB +1 B
ℹ️ View Unchanged
Filename Size Change
build/a11y/index.js 1.14 kB 0 B
build/annotations/index.js 3.62 kB 0 B
build/api-fetch/index.js 3.4 kB 0 B
build/autop/index.js 2.83 kB 0 B
build/blob/index.js 620 B 0 B
build/block-directory/index.js 6.75 kB 0 B
build/block-directory/style-rtl.css 892 B 0 B
build/block-directory/style.css 892 B 0 B
build/block-editor/index.js 106 kB 0 B
build/block-editor/style-rtl.css 11.4 kB 0 B
build/block-editor/style.css 11.4 kB 0 B
build/block-library/editor-rtl.css 7.87 kB 0 B
build/block-library/editor.css 7.87 kB 0 B
build/block-library/style-rtl.css 7.72 kB 0 B
build/block-library/style.css 7.72 kB 0 B
build/block-library/theme-rtl.css 684 B 0 B
build/block-library/theme.css 686 B 0 B
build/block-serialization-default-parser/index.js 1.88 kB 0 B
build/block-serialization-spec-parser/index.js 3.1 kB 0 B
build/blocks/index.js 48.1 kB 0 B
build/components/style-rtl.css 19.5 kB 0 B
build/components/style.css 19.5 kB 0 B
build/compose/index.js 9.31 kB 0 B
build/core-data/index.js 11.4 kB 0 B
build/data-controls/index.js 1.29 kB 0 B
build/data/index.js 8.45 kB 0 B
build/date/index.js 5.47 kB 0 B
build/deprecated/index.js 771 B 0 B
build/dom-ready/index.js 568 B 0 B
build/dom/index.js 3.17 kB 0 B
build/edit-navigation/index.js 8.25 kB 0 B
build/edit-navigation/style-rtl.css 918 B 0 B
build/edit-navigation/style.css 919 B 0 B
build/edit-post/index.js 303 kB 0 B
build/edit-post/style-rtl.css 5.43 kB 0 B
build/edit-post/style.css 5.43 kB 0 B
build/edit-site/index.js 15.5 kB 0 B
build/edit-site/style-rtl.css 2.96 kB 0 B
build/edit-site/style.css 2.96 kB 0 B
build/edit-widgets/index.js 9.33 kB 0 B
build/edit-widgets/style-rtl.css 2.4 kB 0 B
build/edit-widgets/style.css 2.4 kB 0 B
build/editor/editor-styles-rtl.css 425 B 0 B
build/editor/editor-styles.css 428 B 0 B
build/editor/index.js 44.7 kB 0 B
build/editor/style-rtl.css 4.26 kB 0 B
build/editor/style.css 4.27 kB 0 B
build/element/index.js 4.64 kB 0 B
build/escape-html/index.js 733 B 0 B
build/format-library/index.js 7.72 kB 0 B
build/format-library/style-rtl.css 502 B 0 B
build/format-library/style.css 502 B 0 B
build/hooks/index.js 2.13 kB 0 B
build/html-entities/index.js 621 B 0 B
build/i18n/index.js 3.56 kB 0 B
build/is-shallow-equal/index.js 711 B 0 B
build/keyboard-shortcuts/index.js 2.52 kB 0 B
build/keycodes/index.js 1.94 kB 0 B
build/list-reusable-blocks/index.js 3.12 kB 0 B
build/list-reusable-blocks/style-rtl.css 226 B 0 B
build/list-reusable-blocks/style.css 226 B 0 B
build/media-utils/index.js 5.3 kB 0 B
build/notices/index.js 1.79 kB 0 B
build/nux/index.js 3.41 kB 0 B
build/nux/style-rtl.css 616 B 0 B
build/nux/style.css 613 B 0 B
build/plugins/index.js 2.56 kB 0 B
build/primitives/index.js 1.5 kB 0 B
build/priority-queue/index.js 789 B 0 B
build/redux-routine/index.js 2.85 kB 0 B
build/rich-text/index.js 14.8 kB 0 B
build/server-side-render/index.js 2.68 kB 0 B
build/shortcode/index.js 1.7 kB 0 B
build/token-list/index.js 1.28 kB 0 B
build/url/index.js 4.06 kB 0 B
build/viewport/index.js 1.85 kB 0 B
build/warning/index.js 1.14 kB 0 B
build/wordcount/index.js 1.17 kB 0 B

compressed-size-action

Copy link
Copy Markdown
Member

@noahtallen noahtallen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! I'm not aware of anything else that needs to be removed, so this looks pretty solid to me 👍 I'd personally like to see a deprecation message, since I'm not sure we did that yet for the tool. (especially since it can be used outside of gutenberg)

Copy link
Copy Markdown
Member

@noahtallen noahtallen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's probably worth getting feedback from some more people (maybe @youknowriad & @gziolo), but this looks good to me 👍

Copy link
Copy Markdown
Member

@gziolo gziolo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work everyone. It was quite a journey but it’s so nice to see it all nicely structured and working pretty well 🎉

Would it be a good time to include wp-env in Create Block tool? I guess having it behind the flag could be a great start that opens doors for further exciting improvements for block developers.

### Bug fix

- Update webpack configuration to not run the Sass loader on CSS files. It's now limited to .scss and .sass files.
- Update webpack configuration to not run the Sass loader on CSS files. It's now limited to .scss and .sass files.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like you use code auto-formatting that adds unnecessary changes. It feels like we should enable Prettier or something similar for markdown files to stop seeing the same file being converted back and forth.

@mkaz you started on linter for markdown, have you had a chance to look at formatters?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is my local prettier running on markdown files.

We can use prettier for almost all file types now.

"playground:dev": "echo \"Please use storybook:dev instead.\"",
"preenv": "npm run check-engines",
"env": "wp-scripts env",
"wp-env": "packages/env/bin/wp-env"
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Have you considered making “npm run env” the primary way to reference it everywhere?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That would be confusing because the binary is wp-env. It's better to be aligned with what people use when invoking a global installation.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I’m not so convinced that the name of binary file should be the main reason to decide. If they know about the underlying tool, they can always call npx wp-env that is shorter.
env is simply shorter and I’m sure that wp-env is something that is largely unfamiliar for folks that contribute.

Anyway, whatever you pick is fine here 🤷‍♂️

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

People have already been using npm run wp-env, and it's in all the docs.

);
process.stdout.write(
chalk.blue(
'\nSee: https://developer.wordpress.org/block-editor/packages/packages-env/\n'
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Npm link would be better because it’s always up to date. The handbook is pinned to the last major WordPress release so might be up to a few months old like it’s the case now with WordPress 5.4.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It'd be nice if the handbook was versioned and we could link to the latest/next version.

- The default babel configuration has changed to only support stage-4 proposals. This affects the `build` and `start` commands that use the bundled babel configuration; if a project provides its own, this change doesn't affect it. [#22083](https://github.com/WordPress/gutenberg/pull/22083)
- The bundled `wp-prettier` dependency has been upgraded from `1.19.1` to `2.0.5`. Refer to the [Prettier 2.0 "2020" blog post](https://prettier.io/blog/2020/03/21/2.0.0.html) for full details about the major changes included in Prettier 2.0.
- The bundled `eslint` dependency has been updated from requiring `^6.8.0` to requiring `^7.1.0`.
- The `env` family of scripts has been removed.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be great to include detailed info about the alternative so people don’t miss the opportunity to migrate. A link to this PR might be also helpful for those who want to explore this change further.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated

@epiqueras epiqueras merged commit ec79363 into master Jun 7, 2020
@epiqueras epiqueras deleted the remove/legacy-env branch June 7, 2020 18:23
@github-actions github-actions bot added this to the Gutenberg 8.3 milestone Jun 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[Tool] WP Scripts /packages/scripts [Type] Breaking Change For PRs that introduce a change that will break existing functionality

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants