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.

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

Packages: New create-block package for block scaffolding #19773

Merged
merged 2 commits into from Jan 24, 2020

Conversation

@gziolo
Copy link
Member

gziolo commented Jan 21, 2020

Description

Closes #10629.

Create Block is proposed to be an officially supported way to create blocks for registering
a block for a WordPress plugin. It offers a modern build setup with no
configuration. It generates PHP, JS, CSS code, and everything else you need to start the project.

It is largely inspired by create-react-app.
Major kudos to @gaearon, the whole Facebook team,
and the React community.

Another way of making a developer’s life easier is to use WP-CLI,
which provides a command-line interface for many actions you might perform on
the WordPress instance. One of the commands wp scaffold block was used as
the baseline for this tool and ES5 template in particular.

The difference between wp scaffold block and this new package is that it scaffold ESNext template by default and bootstraps everything that is necessary to maintain modern JavaScript tooling in the project.

All this work can be tested also on npm using https://www.npmjs.com/package/create-wordpress-block that was created to validate the idea, test publishing workflow and collect the initial feedback

Usage

The following command generates PHP, JS and CSS code for registering a block.

$ npm init @wordpress/block [options] [slug]

[slug] is optional. When provided it triggers the quick mode where it is used
as the block slug used for its identification, the output location for scaffolded files,
and the name of the WordPress plugin. The rest of the configuration is set to all
default values.

Options:

-t, --template <name>  template type name, allowed values: "es5", "esnext" (default: "esnext")
-V, --version          output the version number
-h, --help             output usage information

More examples:

  1. Interactive mode - it gives a chance to customize a few most important options
    before the code gets generated.
$ npm init @wordpress/block
  1. ES5 template – it is also possible to pick ES5 template when you don't want
    to deal with a build step (npm start) which enables ESNext and JSX support.
$ npm init @wordpress/block --template es5
  1. Help – you need to use npx to output usage information.
$ npx @wordpress/create-block --help

When you scaffold a block, you must provide at least a slug name, the namespace
which usually corresponds to either the theme or plugin name, and the category.
In most cases, we recommended pairing blocks with plugins rather than themes,
because only using plugin ensures that all blocks still work when your theme changes.

Available Commands

Inside that bootstrapped directory (it doesn't apply to es5 template), you
can run several commands:

$ npm start

Starts the build for development. Learn more.

$ npm run build

Builds the code for production. Learn more.

$ npm run lint:css

Lints CSS files. Learn more.

$ npm run lint:js

Lints JavaScript files. Learn more.

$ npm run packages-update

Updates WordPress packages to the latest version. Learn more.

How has this been tested?

This package is still not published to npm out of the obvious reasons, so the temporary way to test it looks as follows:

npx wp-create-block --help

Screen Shot 2020-01-21 at 11 31 58

npx wp-create-block --version

Screen Shot 2020-01-21 at 11 32 47

npx wp-create-block - to see full interactive mode (npm install during the process takes some time)

wp-create-block

npx wp-create-block my-quick-block - to see quick mode

npx wp-create-block --template es5 - to scaffold ES5 template

Types of changes

New package.

Checklist:

  • My code is tested.
  • My code follows the WordPress code style.
  • My code follows the accessibility standards.
  • My code has proper inline documentation.
  • I've included developer documentation if appropriate.
  • I've updated all React Native files affected by any refactorings/renamings in this PR. .
@gziolo gziolo added the Npm Packages label Jan 21, 2020
@gziolo gziolo requested review from ajitbohra and chrisvanpatten as code owners Jan 21, 2020
@gziolo gziolo self-assigned this Jan 21, 2020
@gziolo gziolo force-pushed the add/create-block-package branch 6 times, most recently from b3c9da0 to bb1fb40 Jan 21, 2020
@gziolo gziolo requested a review from WordPress/gutenberg-core Jan 21, 2020
@ItsJonQ

This comment has been minimized.

Copy link
Contributor

ItsJonQ commented Jan 21, 2020

@gziolo I just tested it and it's working as advertised!

Screen Shot 2020-01-21 at 9 20 49 AM

Works, out of the box, when generated into a WordPress plugins directly.
npm start automatically watches/rebuilds.

CSS-aside, the workflow feels identical to that of create-guten-block 🙌 .


Import awesomeness

It's a tiny detail, but I really have to commend you for leveraging wp-scripts for the start/build scripts. From a Gutenberg project dev perspective, this choice seems obvious.

However, for a block plugin author dev perspective, this means that I can use import for Gutenberg packages, for example:

import { Button } from '@wordpress/components';

Rather than from the global (window) namespace:

const { Button } = wp.components

CSS (Question)

I noticed that the .css files were outside of the src/ directory. Based on my experiences with projects like create-react-app, I expected (almost) everything to be there. Is this something we're planning to do in the future?

(Open question! I'm not disagreeing with the current implementation)


Thanks again for your efforts! You've created the foundations for something really special for the Gutenberg project IMO ❤️

@gziolo

This comment has been minimized.

Copy link
Member Author

gziolo commented Jan 21, 2020

I noticed that the .css files were outside of the src/ directory. Based on my experiences with projects like create-react-app, I expected (almost) everything to be there. Is this something we're planning to do in the future?

(Open question! I'm not disagreeing with the current implementation)

I fully agree that it isn't the best experience with regard to CSS. The majority of custom configurations for WordPress development I've seen so far allow CSS import statements. I think we should follow the same approach and finally implement #14801. I'm wondering if we could add something similar to what is used for the Storybook:

test: /\.scss$/,
use: [
'style-loader',
'css-loader',
/**
* Configuring PostCSS with Webpack
* https://github.com/postcss/postcss-loader#plugins
*/
{
loader: 'postcss-loader',
options: {
ident: 'postcss',
plugins: () => postCssConfigPlugins,
},
},
'sass-loader',
],
include: path.resolve( __dirname ),

I went with static files for the time being. The package is at the moment versioned 0.5.1 which reflects its current status.

Nice to have features for v1.0.0 would be:

  • native support for CSS imports (#14801)
  • readme.txt file template included for the plugin (gziolo/create-wordpress-block#1)
  • a script to generate the zip file for the plugin so authors could have an easy workflow for distribution (#19237)
@gziolo gziolo force-pushed the add/create-block-package branch from bb1fb40 to 260345b Jan 23, 2020
@gziolo

This comment has been minimized.

Copy link
Member Author

gziolo commented Jan 23, 2020

Props to @aduth for the tip about making action async in the commander setup, code changes 260345b.

@aduth
aduth approved these changes Jan 23, 2020
packages/create-block/README.md Show resolved Hide resolved
packages/create-block/index.js Show resolved Hide resolved
packages/create-block/lib/index.js Show resolved Hide resolved
packages/create-block/lib/index.js Show resolved Hide resolved
packages/create-block/lib/index.js Show resolved Hide resolved
packages/create-block/lib/prompts.js Show resolved Hide resolved
packages/create-block/lib/prompts.js Show resolved Hide resolved
packages/create-block/lib/scaffold.js Show resolved Hide resolved
packages/create-block/lib/scaffold.js Show resolved Hide resolved
packages/create-block/package.json Show resolved Hide resolved
@gziolo

This comment has been minimized.

Copy link
Member Author

gziolo commented Jan 24, 2020

Thanks @aduth for you feedback. I really appreciate all the comments. I will merge this PR as is and open a follow-up according to the comments I left to make the process simpler.

@gziolo gziolo merged commit bc57547 into master Jan 24, 2020
1 check passed
1 check passed
Travis CI - Pull Request Build Passed
Details
@gziolo gziolo deleted the add/create-block-package branch Jan 24, 2020
@gziolo

This comment has been minimized.

Copy link
Member Author

gziolo commented Jan 24, 2020

I started #19867 which partially addresses feedback shared. I will continue to work on Monday.

@youknowriad

This comment has been minimized.

Copy link
Contributor

youknowriad commented Jan 27, 2020

This is cool.

gziolo added a commit that referenced this pull request Jan 27, 2020
Props to @aduth for the proposal: #19773 (comment).
gziolo added a commit that referenced this pull request Jan 27, 2020
gziolo added a commit that referenced this pull request Jan 30, 2020
gziolo added a commit that referenced this pull request Jan 31, 2020
…9867)

* Create block: Code quality improvements for the block scaffolding

* Improve the strucutre and handling of templates
Props to @aduth for the proposal: #19773 (comment).

* Ensure that package-lock.json file is refreshed with the changes from master

* Docs: Add a note about version and help options

* Code style: Run Prettier formatting on the package files

* Create block: Align .editorconfig with Gutenberg settings

* Fix: Use the description provided to fill the `description` field in `package.json` file in ESNext template

* Fix: Ensure that values provided for slug and namespace get converted to lower case

* Fix: Simplify the logic for transforming slug to title

* Update packages/create-block/lib/templates.js

Co-Authored-By: Andrew Duthie <andrew@andrewduthie.com>

Co-authored-by: Andrew Duthie <andrew@andrewduthie.com>
@epiqueras epiqueras added this to the Gutenberg 7.4 milestone Feb 3, 2020
@strarsis

This comment has been minimized.

Copy link

strarsis commented Feb 10, 2020

@gziolo:

/home/build/.npm/_npx/13386/lib/node_modules/@wordpress/create-block/lib/scaffold.js:6
const { readFile, writeFile } = require( 'fs' ).promises;
        ^

TypeError: Cannot destructure property `readFile` of 'undefined' or 'null'.

with npm init @wordpress/block on node v8.14.0 (LTS),
npm 6.13.7 and WSL 1 Ubuntu (stable) (Bash on Windows).

@gziolo

This comment has been minimized.

Copy link
Member Author

gziolo commented Feb 10, 2020

Node 10.0.0+ is required, see:
https://github.com/WordPress/gutenberg/tree/master/packages/create-block#quick-start

(requires node version 10.0.0 or above, and npm version 6.1.0 or above)

I'll open an issue to add version checking in the script. Promises API for fs was added in Node 10.x.

Aside: Node 8.x is no longer maintained. See: https://github.com/nodejs/Release#release-schedule

@gziolo

This comment has been minimized.

Copy link
Member Author

gziolo commented Feb 10, 2020

@strarsis – opened #20142 to track the issue you raised.

hypest added a commit that referenced this pull request Feb 10, 2020
* Use Select: Fix render queue. (#19286)

* Use Select: Fix render queue issues.

* Use Select: Make `isMounted` more informative.

* Framework: Reset lockfile changes to dependencies

Co-authored-by: Andrew Duthie <andrew@andrewduthie.com>

* Project Management: Run pull request automation on closed (#19742)

* Try/group block custom text color (#19181)

* Add text color selector to group block to allow setting a text colour that applies to all children of the group to avoid having to set text colour on every individual child

* Block Editor: Handle LinkControl submission via form handler (#19651)

* Block Editor: Handle LinkControl submission via form handler

* E2E Tests: Unskip intermittent buttons test failure

* Added conditions and new translation strings for BlockMover (#19757)

* Added conditions and new translation strings for BlockMover

* Moved translator comments into sprintf function

* Storybook: Add Placeholder component story (#19734)

* Add Placeholder story for storybook

* Update storybook test snapshot

* Project Management: Fix pull request merge automation errors (#19768)

* Framework: Use fixed version of checkout action

Avoid unintended breaking changes. To a lesser extent, helps clarify that this tag refers to the _version of the action_, not the branch being checked out.

* Framework: Configure PR automation checkout to master branch

* Add post requests documentation for apiFetch (#19759)

* Multi-select: don't focus first selected block (#19762)

* Multi-select: don't focus first selected block

* Move CopyHandler outside WritingFlow

* Fix click appender

* Remove useless line

* Update: Readme.txt Link to changelog instead of adding it inline(#19761)

* Fix: Media & Text: "Crop image to fill entire column" reset on image change (#19765)

* Build: Include JSON files in zip archive (#19772)

* Build: Include JSON files

* Zip build script: Include json files in `build/block-library/blocks/`

Co-Authored-By: Jorge Bernal <jorge@automattic.com>

Co-authored-by: Jorge Bernal <jbernal@gmail.com>

* Makes appenders visible only for the current selection (#19598)

* makes appenders visible only for the current selection

* adds smaller footprint to appenders in navigation, only shows them if item has descendants

* align appender to level of the menu item, remove useless CSS

* Core-data: do not publish outdated state to subscribers during updates (#19752)

* Core-data: do not publish outdated state to subscribers during updates

Calling `saveEntityRecord` with an update does the following:

1. Calls `getEntityRecord` to fetch the current persisted state of the entity record
2. Calls `receiveEntityRecords` with the new up-to-date state to render the updates
3. Sends an API fetch with the update patch to persist the update
4. Calls `receiveEntityRecords` again with the new up-to-date *persisted*
state

The issue here, is that point 1 (Calling `getEntityRecord`) not only fetches
the persisted state, but it also internally calls `receiveEntityRecords` itself .
This results in the persisted outdated server state to be rendered
on the UI, causing a flickering effect, that jumps pack when point 2
takes turn.

This commit removes the call to getEntityRecord, and instead, it just
calls receiveEntityRecords with the local up-to-date state of the entity
record. This fixes the flickering issue.

* Core-data: update tests to match saveEntityRecord yeilded actions

Given `saveEntityRecord` no longer selects `getEntityRecord`,
which itself triggers a SELECT action, two SELECTs are no longer
yielded. This commit removes the expectation of these two SELECTs.

* Core-data: Introduce getEntityRecordNoResolver selector

To allow saveEntityRecord access the latest local full version
of an entity without issung an API request. This prevents
propogating outdating states to subscribers when
saveEntityRecord is called.

See: #19752 (comment)

* Address review comments at #19752:

1. Capitalize alll added comment messages
2. Alias getEntityRecord with getEntityRecordNoResolver instead of copying it
3. Use describe.each instaed of looping manually in selectors tests

* Add WordPress primitives package (#19781)

* navigation-link: set page id in the attrs (#18641)

* Project management: Add step that updates CHANGELOG files before npm releases (#19764)

* Navigation Block: Add submenu chevron w/ setting (#19601)

* Initialize setting in the nav block settings panel

* Add submenu icon

* Register "showSubmenuIcon" attributes

* Add submenu icon to front-end of the page

* Update submenu icon setting description

* Don't use <span> for RichText element

* Isolate NavigationLink icons

* Clean up a little

* Use <span> for NavigationLink contents

* Rename `$level_zero` to `$is_level_zero`

* Add missing spaces

* Update submenu icon selector in style.scss

* Add comment about span-wrapping

* Fix phpcs errors

* Remove unused styles

* Fix failing e2e tests

* Update failing snapshots

* Embed: Fix failure placeholder alignment/sizing (#19673)

* Fix error message sizing + alignment in Embed Placeholder

* Fix Table placeholder input vs button alignment

* Adjust spacing between error message and buttons

* Fix card component sub-component example code (#19802)

* Introduce the Icons package (#17055)

* Expose @wordpress/icons to react-native (#19810)

* Block popover: allow scrolling over (#19769)

* Block popover: allow scrolling over

* Clean up

* Fix overlapping inserter popover

* Better comment

* Multi select: keep selection after move (#19784)

* Multi select: keep selection after move

* Add e2e test

* Change e2e test

* Address feedback

* Fix snapshots

* Bump plugin version to 7.3.0

* Navigation: Select parent navigation block on handleCreateFromExistingPages() action (#19817)

* Paragraph block: remove dead CSS (#19821)

* Bundle the icons package instead of using it as an external (#19809)

* Move a dozen of block icons to the icons package (#19808)

* Chore: Improve package-lock.json configuration

* Add mkevins and pinarol as code owners for gallery block (#19829)

* Added shippedProposals (#19065)

* Added shippedProposals

* Setting shippedProposals during init

* Rich text: remove is-selected class (#19822)

* Rich text: prefix is-selected class

* Adjust more cases

* Remove the class

* Move more block SVGs to the icons package (#19834)

* Block: use context to provide selected element (#19782)

* Block: use context to provide selected element

* Include multi selection nodes

* Add comment

* Popover: clean up requestAnimationFrame (#19771)

* Popover: clean up requestAnimationFrame

* Cancel the last request before a new request

* Update: Removed editor store usage from native mobile block ed… (#18794)

* Navigation: Manage navigation link appender visibility based on current selection (#19846)

Show the navigation link appender when the selected item has descendants and is selected, or if it's the parent of the selected block.

* Remove editor dependency from the block library (#16160)

* Add AnglePicker Component; Add useDragging hook (#19637)

This commit adds a component to pick angles and a hook to make dragging things easier to implement.
Some components will be refactored to use the new hook e.g: the custom gradient picker.

* Testing: Use deterministic selectors for incremented IDs (#19844)

* Innerblock Templates Docs Link Typo Issue Fixed (#19813)

* Innerblock Templates Docs Link Typo Issue Fixed

* Innerblock Templates Docs Link Typo Issue Fixed

* Rich text: enable if multi selection is aborted (#19839)

* Block Directory: Refactor the reducer by breaking out the block management actions into their own reducer. (#19330)

* Block Directory: Refactory the reducer by break out the block management actions into their own reducer.

* Moved hasPermission into its own reducer.
* Also remove the 'items' list as it's not being used

* Update the getInstalledBlockTypes selector to point to the new reducer that manages installs.

* Update typo in test.

* Remove the lodash dependency in the selectors. It isn\'t necessary.

* Fix panel header styles (#19842)

* Move more block icons to the icons package (#19838)

* Bump @babel/preset-env to 7.8.3 (Optional Chaining!) (#19831)

* Bump babel to 7.8.3

* Added test for optional chaining

* Bump other babel packages.

* Fix

* Changelog
Update CHANGELOG.md

* Update package-lock.json

Co-authored-by: Grzegorz (Greg) Ziółkowski <grzegorz@gziolo.pl>

* Style improvements for template previews (#19763)

* First scaffold for template previews (mobile only)

* WIP: managed to make the preview show, saving as a checkpoint

- BlockEditorProvider needs an update so it uses the subRegistry
- We need a better way to only render the picker on the main block list
- We need to make the bottom sheet full height, and adapt the block preview accordingly

* Set a fixed height for the template preview

* Move template picker to the toolbar

* Read only block list

* Lint fixes

* Made scrolling sort of working with read only block list

* A longer template to test scrolling

* Replace BottomSheet with Modal for previews

* Allow closing previews with back button on Android

* Revert changes to BlockList that were required for bottom sheet integration

* Revert changes to BottomSheet

* Add usage example for ModalHeaderBar

* Improve accessibility of template preview

* Improve accessibility of ModalHeaderBar

* Remove unused imports

* Added missing web file

* RNMobile - Page template picker: apply layout from the preview

* RNMobile - Layout preview: apply action

* RNMobile - Page templates - set layout action

* Remove mobile action from docs

* New components for modal header buttons

* Fix alignment of modal header buttons

* Fix metrics for iOS modal header

* Add subtitle to preview header

* Use named color for modal header button

* Updated modal title color and weight

* Make Apply button bolder on iOS

* Make Apply button bolder on iOS

* Fix vertical alignment for close button

* Allow modal rotation on iOS

* Fix modal background on dark mode

* Fixed dark mode for template previews

* Revert changes to editor store after bad merge

* Add material close icon for modal header

* Tweak modal title colors

* Lint fixes

Co-authored-by: Gerardo Pacheco <gerardo.pacheco@automattic.com>

* [RNMobile] Release v1.21.0 to master (#19854)

* Adding empty function to RichText children call. (#19818)

This fixes a crash originated on this PR:
#19536
`

* Disable gallery image size options on mobile (#19828)

* Revert "Disable gallery image size options on mobile (#19828)"

This reverts commit 47b74aa.

Co-authored-by: Matthew Kevins <mkevins@users.noreply.github.com>

* Packages: New create-block package for block scaffolding (#19773)

* Packages: New create-block package for block scaffolding

* Promote action handler to async to make implementation simpler

* Pass the prop for selection color. (#19635)

* Do not use the deprecated package editor for InnerBlocks component (#19869)

* Remove dead is-hovered selectors (#19870)

* Move is-navigate-mode class to WritingFlow (#19868)

* [RNmobile] Upgrade to RN 0.61.5 (#19369)

* `focusable` replaced `clickable

See facebook/react-native#25274

* Provide a native colors.native.scss

* Upgrade React Native version in Gutenberg web repo

* Jest doesn't have hasteImplModulePath anymore

* Work around other regressions. Will revert when those fixed

* Bump react-native version to 0.61.5

* Update babel-jest to try fixing babel-plugin-jest-hoist jest.mock issue

* Update jest to try fixing babel-plugin-jest-hoist jest.mock issue

* Pin xmldom to older version to bypass license file ambiguity

With newer versions, the license check script doesn't recognise that the
package is dual licenced and is reporting it as incompatible.

This commit pins the package to an older version. There is no functional
difference between the two versions, see
xmldom/xmldom@v0.1.27...v0.1.30

* Revert "Provide a native colors.native.scss"

This reverts commit b05f1e4.

This shouldn't be needed anymore after
wordpress-mobile/gutenberg-mobile#1683

* Revert "Pin xmldom to older version to bypass license file ambiguity"

This reverts commit 7e3c2b5.

* Cater for lowercase OR in licenses types

Props to @pento for the solution
#19369 (comment)

* Update package-lock.json via npm v6.13.6

* Check for the same "or" format as we're splitting

Otherwise, the 'or' in `GPL-2.0-or-later` causes an infinite recursion.
See error in https://travis-ci.com/WordPress/gutenberg/jobs/278348885.

* Update package-lock.json after running run check-local-changes

* Fix package-lock.json conflicts by keeping Jest to 24.9.0, Babel to
7.8.3

* Update package-lock by running npm install

* Update README.md (#19876)

Fix typo

* Multi selection: fix intermittent e2e failure (#19865)

* Move more block icons to the icons library (#19862)

* Paragraph block: remove min-height (#19835)

* Paragraph block: remove min-height

* Use lineheight to set drop cap min height

* Framework: Fix server-registered fixtures script (#19884)

* Env: Format run output only for terminal display

* Framework: Fix server-registered fixtures script

* Testing: Regenerate server-registered fixtures

* Testing: Regenerate navigation block fixture

* Env: Fix CHANGELOG typo "or"

* Shortcode Design Review (#19852)

* Update style of shortcode based on design review

* Fix title colors

* Update component to components in CONTRIBUTING.md (#19914)

* Apply sentence case formatting to PanelBody titles (#19901)

* Color Settings -> Color settings

* Block PanelBody titles: Settings -> settings

* Clarify when isEligible function is called (#19899)

Added a note that isEligible is only used for valid blocks and is not called for invalid blocks.

* Block Editor: Refactor ObserveTyping as function component (#19881)

* Block Editor: Refactor ObserveTyping as function component

* Block Editor: ObserveTyping: Avoid persisting event

* Remove unnecessary import from playground (#19893)

* Documentation: Organize Contributors Guide (#19853)

* Simplify CONTRIBUTING.md to be just guidelines

We don't need to include too much here because the real information for
contributing is in the handbook. This page is a standard page for Github
repos, so trimming it down to just a few links to sections in the
handbook.

Plus the policies for code of conduct and GPL.

* Add design contribution from CONTRIBUTING.md to design page

* Cleanup and organize Contributors Guide

* Use consistent Contributors Guide title

* Move Principles and catch-all docs to Project Overview section

* Switch background to more relevant repository management

* Apply suggestions from code review

Thanks for the fixes 👍

Co-Authored-By: Chris Van Patten <hello@chrisvanpatten.com>

* Fix extra newlines

* Standardize on Contributor Guide, matches core handbook

* Update manifest

Co-authored-by: Chris Van Patten <hello@chrisvanpatten.com>

* [RNMobile] Correct isMobile condition in nested Media&Text (#19778)

* Correct isMobile condition in nested Media&Text

* Do not export BREAKPOINTS

* Blocks: Match blocks in the inserter using keywords from patterns (#19243)

* Blocks: Match blocks in the inserter using keywords from patterns

* Ensure that matched patterns with the search term are marked

* Introduce scopes for block patterns

* Make it possible to apply initial attributes and inner blocks directly from the inserter

* Update block preview in the inserter to use attributes from the variation

* Change the way patterns are handled in the inserter

* Update packages/block-editor/src/components/block-types-list/index.js

Co-Authored-By: Miguel Fonseca <miguelcsf@gmail.com>

* Improve the way patterns are added to the inserter

* Rename pattern label to patter title to align with block types

* Inserter: Don't auto-add block if it has variations

Co-authored-by: Miguel Fonseca <miguelcsf@gmail.com>

* Block editor: Alt+F10 shouldn't scroll to top (#19896)

* Add e2e test

* Leave fixed position until position can be set

* Multi-selection: fix clearing with side click (#19787)

* Multi-selection: fix clearing with side click

* Add e2e test

* [RNMobile] fix show appender and separator in Group block (#19908)

* fix appender to duplicate separator line

* Add docs for LocalAutosaveMonitor and __experimentalUpdateLocalAutosaveInterval (#19915)

* [RNMobile] Add media edit icon to image block (#19723)

* Creates a MediaEdit component that shows a picker

* Add Gridicon's customize icon

* Show a button in images block that displays a picker

* Fix lint issues

* Fix no-shadow error

* Fix the name of the params

* When "Edit" is selected, request the Media Editor

* Fix lint issues

* Change media editor ID to a constant

* When "Replace" is tapped, show all available media options

* Fix lint issues

* Avoid destructuring

* Block Library: Handle Popover onClose for LinkControl (#19885)

* Block Library: Handle Popover onClose for LinkControl

* E2E Tests: Verify link popover Escape handling

* Disable Autocomplete in shortcode block (#19848)

* Disable Autocomplete in shortcode block

* RichText API: Limit `prefix` transformations to Paragraph (#19727)

… and any consumer of RichText that provides experimental prop
`__unstableAllowPrefixTransformations.`

* Block Editor: LinkControl: Resolve error when undefined value, "view" state (#19856)

* Block Editor: LinkControl: Resolve error when undefined value, "view" state

* Block Editor: LinkControl: Document only url, title, opensInNewTab value properties

* Block Editor: LinkControl: Change documented example to reference known value property

* [RNMobile] Revert change to fix Action Sheet (#19934)

* Revert "Avoid destructuring"

This reverts commit e113310.

* Fix the var name

* Add background color support to Columns block (#17813)

* Add attributes

* Update edit function

* Update save function

* Add .has-background style

* Improve has-background and backgroundColor.class checks

* Try passing the columns block e2e test

* Refactor to use __experimentalUseColors

* Normalize has-background padding with variables

* Remove extra bit

* Fix RTL styling for Media Text block (#18764)

* Add proper !rtl ignore comments to maintain styling on RTL

* Tweak comment

* Add direction: ltr (not ignored) to the content container

* change order of composing style in svg primitive (#19927)

* Add Prettier formatting script (#18048)

* Add Prettier NPM dependency to packages/scripts and top-level

* Scripts: export the fromProjectRoot function from scripts/utils module

* Scripts: Add Prettier formatting script

* ESLint config: use default (linebreak before ternary op) config for operator-linebreak rule

* ESLint: disable formatting rules in the recommended config

Adds `eslint-config-prettier` to the recommended config and creates an alternative
`recommended-with-formatting` config for project that want to keep ESLint formatting
rules and opt-out of Prettier.

* Scripts: the format-js script checks if Prettier is present and has top-level config

Prettier presence in a `wp-scripts`-powered project is optional, and the `format-js` script
checks if it's there and if it's indeed the fork (`wp-prettier`). Will report error otherwise.

Also, require a top-level Prettier config to be present. We can't default to the one inside
`wp-scripts`, because IDE and editor integrations won't find it there and will use the Prettier
defaults.

* Bump the minimum required version of npm to 6.9.0

* Add ESLint config changes notice to changelog

* Update package-lock.json

* Regenerate package-lock.json

Co-authored-by: Grzegorz (Greg) Ziółkowski <grzegorz@gziolo.pl>

* Components: FontSizePicker: Adjust Select Button sizing (#19479)

* Documentation: fix typo "Th" to "The" (#19833)

* [RNMobile] Long-press on inserter to show options for "add above" and "add below" (#18791)

* Add onLongPress prop to Button

* Show inserter menu on long press

* Make onLongPress a prop of toggle

* Make withSelect of Inserter return destinationRootClientId

* Insert default block before the selected one on long press

* Add add canReplaceBlock key to the insertionPoint state

* Hide a block in list only if it can be replaced

* Move insertion index logic from menu to inserter

* Update selector tests for newly added key in state

* Add insertionIndexAfter and isAnyBlockSelected props with selector

* Update docs for newly added key in state

* Add insertionType to component state and map to insertion index

* Refactor insertion index logic

* Show BottomSheet on long press to choose to insert before or after

* Update UI strings to be title case

* Hide cancel button from Bottom Sheet on Android

* Add icons to Bottom Sheet options on Android

* Add “Replace Current Block” option to menu on long-press

* Scroll to newly added block if it doesn't trigger keyboard to open

* Change “Replace Current Block” menu icon on Android

* Use shorter syntax for setState

* Rename getShouldReplaceBlock method to shouldReplaceBlock

* Revert "Scroll to newly added block if it doesn't trigger keyboard to open"

This reverts commit 9c1c71d.

* Revert “Add canReplaceBlock key to the insertionPoint state"

* Remove Block show/hide logic from BlockList

* Update Inserter local state to store block insertion information

* Make InserterMenu add/remove unmodified default block during replace

* Handle replacing last remaining block

* Fix Inserter test

* Fix code style issue

* Move insertion options into getInsertionOptions function

* Add comment about removing last block case

* Use findByProps instead of toJSON when testing Inserter

* Docs: Add details for format-js to @wordpress/scripts package (#19946)

* Docs: Add details for format-js to @wordpress/scripts package

* Update README.md

* Update packages/eslint-plugin/CHANGELOG.md

Co-Authored-By: Marcus Kazmierczak <marcus@mkaz.com>

Co-authored-by: Marcus Kazmierczak <marcus@mkaz.com>

* Fix: Crash when creating a hierarchical post without title (#19936)

* Fix: Color Gradients component was not able to handle only gra… (#19925)

* Add markdownlint script to lint docs markup (#19855)

* Add markdownlint script to lint docs markup

Adds a new script `lint-md-docs` that runs markdownlint to lint markdown
files for proper syntax. A default `.markdownlint.json` config is
included, it will require some testing to tune.

Fixes #12426

* Clarify naming of lint-md scripts js and docs

- Updates lint-md scripts to lint-md-js for linting source included in the document and lint-md-docs for
linting the markup of the document itself.

- Update scripts changelog
- Update readme with commands

* Apply suggestions from code review

Co-Authored-By: Grzegorz (Greg) Ziółkowski <grzegorz@gziolo.pl>

* Fix URL for markdownlint CLI

* Add -i check, details around ignore on CLI

* Check for additional project config files

* Update script commands to all for lint:*

* Local changes applied to package-lock.json

* Update packages/scripts/README.md

Co-Authored-By: Grzegorz (Greg) Ziółkowski <grzegorz@gziolo.pl>

* Apply suggestions from code review

Thanks for the review and updates 👍

Co-Authored-By: Grzegorz (Greg) Ziółkowski <grzegorz@gziolo.pl>

Co-authored-by: Grzegorz (Greg) Ziółkowski <grzegorz@gziolo.pl>

* Use require.resolve() instead of <rootDir> in @wordpress/jest-preset-default (#19957)

* use require.resolve() instead of <rootDir>

* formatted

* added changelog entry (#19958)

* Move the insert dashicon to the icons package (#19943)

* Replace all occurences of the yes dashicon with the check icon from the icons package (#19926)

* Build: Include block.json files in the build output (#19786)

* Block Editor: LinkControl: Prevent focus loss in edit mode toggle (#19931)

* Block Editor: LinkControl: Prevent focus loss in edit mode toggle

* Block Library: Remove custom focus loss protection

Previously used effect lifecycle to anticipate and respond to focus loss. Now, focus loss is prevented by LinkControl.

See: 722a4d6

* Block Editor: Rephrase and move forced input rendering comment

* Block Editor: Ensure isEndingEditWithFocus always assigned as boolean

* Move Alignment, movers and trash icons to the icons package (#19944)

* Navigation Block: Move the link description panel below the SEO panel because this is likely to be used signficantly less than the SEO panel. (#19917)

* Update hover and focus selectors for Move to Trash to ensure they're always red (#19974)

- Updates the selectors in .editor-post-trash to use similar
  specificity as .components-button.is-link for the hover
  and focus states to ensure that they are always red.

* Create block: Code quality improvements for the block scaffolding (#19867)

* Create block: Code quality improvements for the block scaffolding

* Improve the strucutre and handling of templates
Props to @aduth for the proposal: #19773 (comment).

* Ensure that package-lock.json file is refreshed with the changes from master

* Docs: Add a note about version and help options

* Code style: Run Prettier formatting on the package files

* Create block: Align .editorconfig with Gutenberg settings

* Fix: Use the description provided to fill the `description` field in `package.json` file in ESNext template

* Fix: Ensure that values provided for slug and namespace get converted to lower case

* Fix: Simplify the logic for transforming slug to title

* Update packages/create-block/lib/templates.js

Co-Authored-By: Andrew Duthie <andrew@andrewduthie.com>

Co-authored-by: Andrew Duthie <andrew@andrewduthie.com>

* Code quality: Enable linting for JS files starting with .

* Popover: fix typo in removing event listener (#19978)

* Eslint Plugin: Lint code formatting. (#19963)

* Eslint Plugin: Lint code formatting.

* Gutenberg: Add code formatting pre-commit hook.

* Eslint Plugin: Update docs.

* Gutenberg: Format code.

* Storybook: Update snapshots.

* [RNMobile] Show the media edit icon only if the block is selected (#19961)

* Only shows the media edit icon if the block is selected

Also, matches the style of the native gallery block buttons

* Fix lint

* Fix: Admin menu collapses for 960px width but editor doesn't (#19970)

* Chore: Fix differences in package-lock.json file

* RichText: try using hooks for wrapper component (#19095)

* Components: Apply width-based modifier classes to Placeholder only when width is known (#19825)

* Components: Apply `is-small` modifier class to Placeholder only when width known

* E2E Tests: Wait for placeholder error display in embed tests

* Testing: Update snapshots for Placeholder class assignment

* Eslint: set line width to 80 (#19992)

* Update config

* npm run lint-js:fix

* Move eslint comments

* Update snapshots

* Editor: Remove post title escaping (#19955)

* Add: Global styles css variables generation mechanism (#19883)

* Navigation: Change UX to move focus to navigation link label and close the LinkControl (#19686)

* When adding a link via the LinkControl, selects/highlights nav link label text if it's url-like. Focuses if not. Automatically adds url-like labels as the label.

* Adds @wordpress/dom to package-lock.json

* Removed test for awaiting for Link Control focus after pressing Enter, as the focus should now be on the navigation link text with the Link Control closed

* Lib: Limit `pre_render_block` extension. (#19989)

* Lib: Limit `pre_render_block` extension.

* Update lib/compat.php

Co-Authored-By: Andrew Duthie <andrew@andrewduthie.com>

Co-authored-by: Andrew Duthie <andrew@andrewduthie.com>

* Fix, update, and sort _rc_ `hasProjectFile` filenames (#19994)

* Update and fix `hasProjectFile` filenames

* Sort `hasProjectFile` filenames

* Update CHANGELOG.md

* Docs: Include CHANGELOG entries from the relocated create-wordpress-block package

* Blocks: Rename patterns to variations in the Block API (#19966)

* Blocks: Rename patterns to variations in the Block API

* Fix: Remove ESLint errors and warnings related to block variations

* [Mobile] Fix gallery upload sync (#19941)

* Invoke mediaUploadSync for gallery in React hook

* Use integer type explicitly for gallery image id

* Set state before attributes on upload success in gallery image

* Use ref hook for concurrency in media placeholder

* Extract dedup function and add comments in media placeholder

* Fix lint

* Use explicit radix with parseInt

Co-Authored-By: Gerardo Pacheco <gerardo.pacheco@automattic.com>

* Import useRef from @wordpress/element

* Fix lint

* Fix lint / prettier

Co-authored-by: Gerardo Pacheco <gerardo.pacheco@automattic.com>

* [Mobile] Fix blank image size labels on mobile (#19800) (#20045)

* Fix blank image size labels on mobile

* Use name instead of label in default imageSizes

* [RNMobile] Enable Dismiss on PlainText in Android (#20095)

* Add flag for determining if running on Android

* Enable Dismiss button on PlainText. Enable show keyboard in Android on PlainText mount

* Enable Dismiss button on PlainText. Enable show keyboard in Android on PlainText mount

Co-authored-by: Enrique Piqueras <epiqueras@users.noreply.github.com>
Co-authored-by: Andrew Duthie <andrew@andrewduthie.com>
Co-authored-by: Glen Davies <glendaviesnz@users.noreply.github.com>
Co-authored-by: Christopher Reece <momotofu@users.noreply.github.com>
Co-authored-by: Marcus Kazmierczak <marcus@mkaz.com>
Co-authored-by: Ella van Durpe <ella@automattic.com>
Co-authored-by: Jorge Costa <jorge.costa@developer.pt>
Co-authored-by: Bernie Reiter <ockham@raz.or.at>
Co-authored-by: Jorge Bernal <jbernal@gmail.com>
Co-authored-by: andrei draganescu <me@andreidraganescu.info>
Co-authored-by: Omar Alshaker <omar@omaralshaker.com>
Co-authored-by: Riad Benguella <benguella@gmail.com>
Co-authored-by: Damián Suárez <rdsuarez@gmail.com>
Co-authored-by: Grzegorz (Greg) Ziółkowski <grzegorz@gziolo.pl>
Co-authored-by: Bart Kalisz <bartlomiej.kalisz@gmail.com>
Co-authored-by: Jon Quach <hello@jonquach.com>
Co-authored-by: Edi Amin <to.ediamin@gmail.com>
Co-authored-by: Seghir Nadir <nadir.seghir@gmail.com>
Co-authored-by: Jerry Jones <jones.jeremydavid@gmail.com>
Co-authored-by: Matthew Kevins <mkevins@users.noreply.github.com>
Co-authored-by: Abdelmajid HAMDANI <abdel.hamdani213@gmail.com>
Co-authored-by: Delowar Hossain <delowardev@gmail.com>
Co-authored-by: Steven Dufresne <steve.dufresne@automattic.com>
Co-authored-by: Adam Boro <adam@adamboro.com>
Co-authored-by: Kukhyeon Heo <sainthkh@naver.com>
Co-authored-by: Gerardo Pacheco <gerardo.pacheco@automattic.com>
Co-authored-by: etoledom <etoledom@icloud.com>
Co-authored-by: Sérgio Estêvão <sergioestevao@gmail.com>
Co-authored-by: Florian TIAR <florian.tiar@theculturetrip.com>
Co-authored-by: Chip <chip.snyder3@gmail.com>
Co-authored-by: Haz <hazdiego@gmail.com>
Co-authored-by: Rich Tabor <hello@themebeans.com>
Co-authored-by: Benjamin Intal <bfintal@gmail.com>
Co-authored-by: Rostislav Wolný <rwolny@gmail.com>
Co-authored-by: Chris Van Patten <hello@chrisvanpatten.com>
Co-authored-by: Luke Walczak <lukasz.walczak.pwr@gmail.com>
Co-authored-by: Miguel Fonseca <miguelcsf@gmail.com>
Co-authored-by: jbinda <jakub.binda@gmail.com>
Co-authored-by: Leandro Alonso <contato@leandroalonso.com>
Co-authored-by: Jarda Snajdr <jsnajdr@gmail.com>
Co-authored-by: Martin Posselt <nekomajin@gmx.de>
Co-authored-by: Ceyhun Ozugur <ceyhunozugur@gmail.com>
Co-authored-by: James Newell <jameslnewell@users.noreply.github.com>
Co-authored-by: Andy Peatling <apeatling@users.noreply.github.com>
Co-authored-by: Andrew Serong <14988353+andrewserong@users.noreply.github.com>
Co-authored-by: Stephen Edgar <stephen@netweb.com.au>
@jorgefilipecosta jorgefilipecosta mentioned this pull request Feb 12, 2020
18 of 25 tasks complete
@devinsays

This comment has been minimized.

Copy link

devinsays commented Feb 18, 2020

Thanks for the great tool! I've been testing it out with a new block.

One issue I just ran across that I assume some other people may have is:
Support for the experimental syntax 'classProperties' isn't currently enabled

I believe I've fixed it by running:
npm install @babel/plugin-proposal-class-properties --save-dev

And then adding this at the bottom of my package.json:

	"babel": {
		"presets": [
			"@wordpress/default"
		],
		"plugins": [
			"@babel/plugin-proposal-class-properties"
		]
	}

If this is the incorrect approach, please let me know!

@gziolo

This comment has been minimized.

Copy link
Member Author

gziolo commented Feb 19, 2020

One issue I just ran across that I assume some other people may have is:
Support for the experimental syntax 'classProperties' isn't currently enabled

Correct. It's all by design. While it's fine to experiment in general, in WordPress core we make our best to use only those features that are standardized. That's why in the case of Babel we use only features that are part of ESNext standard or were accepted to be added in the next revision. The only exception is JSX.

I believe I've fixed it by running:
npm install @babel/plugin-proposal-class-properties --save-dev

And then adding this at the bottom of my package.json:

	"babel": {
		"presets": [
			"@wordpress/default"
		],
		"plugins": [
			"@babel/plugin-proposal-class-properties"
		]
	}

If this is the incorrect approach, please let me know!

Yes, it's all good. For reference, you can check how we override it in Gutenberg:

module.exports = function( api ) {
api.cache( true );
return {
presets: [ '@wordpress/babel-preset-default' ],
plugins: [ 'babel-plugin-emotion', 'babel-plugin-inline-json-import' ],
};
};

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

8 participants
You can’t perform that action at this time.