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

Add Prettier formatting script #18048

Merged
merged 10 commits into from
Jan 29, 2020
Merged

Add Prettier formatting script #18048

merged 10 commits into from
Jan 29, 2020

Conversation

jsnajdr
Copy link
Member

@jsnajdr jsnajdr commented Oct 21, 2019

This PR adds support for wp-prettier, a Prettier fork that follows the WordPress code conventions and inserts extra spaces inside parens:

function fun( param ) {
  foo( [ 1, 2 ], ( val ) => {
    return `key-${ val }`;
  } );
}

I've been maintaining the fork for 2+ years, from version 1.5 to the latest 1.18.2, and it's been super-useful in Automattic projects like Calypso or Jetpack.

Add a format-js script to @wordpress/scripts:
There is a new script that can be used to format a source directory like this:

wp-scripts format-js packages/compose

The arguments are a list of files and directories to be formatted (globs are possible, too), and it will format all matching JS files, while respecting the ignores in the default .eslintignore.

Remove conflicting ESLint rules:
Some ESLint rules that guard formatting are known to conflict with Prettier (difference in opinions about what's the "right" format), so I'm disabling these that check for things that are automatically handled by Prettier. There's also an eslint-config-prettier ESLint plugin for that.

Format packages/compose to get a taste of Prettier:
This PR also includes formatting of one small module to get a taste of how the formatting changes look like.

TODO: incremental adoption
One proven way how to adopt Prettier incrementally in a large codebase is this one:

  1. Whenever a file is formatted with Prettier, add a /** @format */ pragma at the beginning. That tells the automated tooling to try keep it formatted.
  2. In a pre-commit hook, check for @format pragma in the modified file and reformat it before committing if the pragma is present. Can be done with lint-staged tool that we already use.

The tooling for that is NOT in this PR. Can be added later if there's an interest in Prettier in the first place.

hasProjectFile( '.prettierrc.yaml' ) ||
hasProjectFile( '.prettierrc.yml' ) ||
hasProjectFile( '.prettierrc.js' ) ||
hasProjectFile( '.prettierrc.config.js' ) ||
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
hasProjectFile( '.prettierrc.config.js' ) ||
hasProjectFile( 'prettierrc.config.js' ) ||

No leading . period, Prettier uses cosmiconfig, see https://prettier.io/docs/en/configuration.html

"eslint": "^6.1.0",
"jest": "^24.7.1",
"jest-puppeteer": "^4.3.0",
"js-yaml": "^3.13.1",
"lodash": "^4.17.15",
"minimist": "^1.2.0",
"npm-package-json-lint": "^3.6.0",
"prettier": "npm:wp-prettier@^1.18.2",
Copy link
Member

Choose a reason for hiding this comment

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

What functionality does the npm: prefix here perform if you don't mind, I've not seen this?

Copy link
Member

Choose a reason for hiding this comment

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

It aliases prettier to wp-prettier, so it will actually use the wp-prettier package under the hood. This was introduced in npm 6.9.

Copy link
Member

Choose a reason for hiding this comment

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

Neat, thanks, this is pretty cool

Copy link
Member

Choose a reason for hiding this comment

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

We would need to enforce that check-engines requires npm 6.9 or higher by default.

Copy link
Member

Choose a reason for hiding this comment

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

Even cooler would be not having to maintain such a fork, but progress is slow on that front: prettier/prettier#5919

Copy link
Member Author

Choose a reason for hiding this comment

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

Note that even if prettier/prettier#5919 was fixed and we could ship wp-prettier as a plugin, it wouldn't change much. We'd still need to maintain a fork of the JS formatter, and then ship the forked formatter as a plugin that replaces the original JS formatter. The code and the work is still the same, just shipped in different packaging.

I could fix prettier/prettier#5919 myself if needed, but with package aliasing support shipping both in NPM and Yarn, the aliasing method works equally well.

Copy link
Member Author

Choose a reason for hiding this comment

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

This was introduced in npm 6.9.

Yes, and it's the main reason why I waited so long before proposing to use the fork. Before package aliases, it could be distributed only as a tarball URL or a GitHub tag ref, which is kind of ugly and doesn't support versioning well. Now, distributing forks of things is much cleaner and easier.

@@ -0,0 +1,12 @@
module.exports = {
useTabs: true,
tabWidth: 2,
Copy link
Member

Choose a reason for hiding this comment

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

Should this be defined? Some devs like 4 spaces, some 2, even 8.

Leaving this as a developer preference for them to set in their Editor/IDE is in line with how WordPress Core uses .editorconfig by not defining a tab width

Copy link
Member Author

Choose a reason for hiding this comment

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

useTabs means that the formatted source will contain tabs and editors can display them freely according to their configuration.

tabWidth is needed only to calculate the line length. If the maximum line length is 80, and the code is indented with tabs, what does the line length number even mean? Nothing. We need to define tabWidth to give the tab a dimension.

Copy link
Member

Choose a reason for hiding this comment

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

Thanks for the explanation 👍🏼

@ntwb
Copy link
Member

ntwb commented Oct 21, 2019

Thanks for the PR @jsnajdr I've added a couple of comments for starters...

What I would like to see though is how Prettier has, or if it has since we looked at it in #4628, our conclusion at the time was this (copying here for ease ref) #4628 (comment):

Prettier and WordPress are both pretty opinionated, though there's only a couple of instances where those opinions really opposed each other, thankfully ESLint's --fix was able to bring a satisfactory compromise.

To that end examing whats left after WordPress has applied its ESLint fixes to the changes made by Prettier is relatively minor, primarily these changes relate to line length, where Prettier refactors the code to not exceed x characters in length, it does a pretty good job of that for the most part. As noted in the comments above sometimes it's not ideal where and when it does this it makes for poorly formatted code.

For the remaining instances of stylistic formatting that Prettier made we can look to add ESLint rules to detect these style inconsistencies and update our coding standards to match. Hopefully we can contribute ESLint rules and fixes upstream as much as possible for the benefit of all ESLint users.

I don't think Prettier is the right solution for WordPress Core, we'll continue to enhance and iterate our JavaScript Coding Standards with ESLint.

Thanks to everyone who has tested and explored the world of Prettier with us here, I've had a blast testing this, closing this PR now, thanks again everyone 😄

I would love to see how Prettier fares today with some of the issues we raised as concerns:

@gziolo gziolo added [Type] Code Quality Issues or PRs that relate to code quality [Type] Enhancement A suggestion for improvement. [Type] Technical Prototype Offers a technical exploration into an idea as an example of what's possible labels Oct 22, 2019
@gziolo
Copy link
Member

gziolo commented Oct 22, 2019

Noting that this PR addresses #2819 which was closed a long time ago due to the issues listed in the previous comment by @ntwb.

@jsnajdr
Copy link
Member Author

jsnajdr commented Oct 22, 2019

I would love to see how Prettier fares today with some of the issues we raised as concerns:

To be honest, the formatting hasn't changed much 🙂 Looking at the concerns that had been raised, I see two where a fix could be proposed upstream:

Botching up alignment of docblock comments inside JSX

<div>
  { /**
   * i'm a docblock
   */ }
</div>;

This is clearly a Prettier bug, as it happens only when the JSX expression container is otherwise empty. Adding anything to it fixes the comment formatting.

Unpleasant breaking of long curry chains with arrowParens=always

const f = ( a ) => ( b ) => (
  c
) => find( a, b, c );

The arrowParens=avoid version of this code doesn't break the line, even if the curry chain is longer than the maximum line length:

const f = a => b => c => // could continue ad infinitum and never breaks
  find( a, b, c );

I think preventing a break for arrow function with a single simple argument is a reasonable change that shouldn't meet much opposition.


But formatting details aside, I think the main reason why this new attempt at Prettier is different is that it removes the need for the eslint --fix step. wp-prettier can insert all the whitespace inside parens correctly, as the WordPress convention requires, and doesn't need any other tool to fix it. There is a new parenSpacing option for that.

Everything else, as I see it, are just subtle differences in opinion about how things should be formatted, they are not specific to the "WordPress culture", if you know what I mean, and don't have a rational resolution that everyone can agree on.

If something seems obviously wrong, as the examples above, we can propose patches upstream. The only WordPress-specific difference seems to be the paren spacing.

@ntwb
Copy link
Member

ntwb commented Oct 22, 2019

Thanks for the detailed reply @jsnajdr 💯

I think it would great to see how this looks on the entire code base, a gist, a fork maybe, then the Gutenberg and WordPress teams can take a closer look...

I'm thinking once the above is available we can document what changes would be required and acceptable to update the WordPress Coding Standards with, and then create a P2 on make.w.org/core for further feedback

@jsnajdr
Copy link
Member Author

jsnajdr commented Oct 22, 2019

I think it would great to see how this looks on the entire code base, a gist, a fork maybe, then the Gutenberg and WordPress teams can take a closer look...

I can reformat the whole codebase and push the diff to this branch. I originally decided to avoid that in order to keep the PR small.

@gziolo
Copy link
Member

gziolo commented Oct 22, 2019

I can reformat the whole codebase and push the diff to this branch. I originally decided to avoid that in order to keep the PR small.

It would be fun to see a branch with all files formatted :)

jsnajdr and others added 9 commits January 28, 2020 10:11
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.
…op-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.
@@ -53,6 +55,7 @@
"lodash": "^4.17.15",
"minimist": "^1.2.0",
"npm-package-json-lint": "^4.0.3",
"prettier": "npm:[email protected]",
Copy link
Member

Choose a reason for hiding this comment

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

I added prettier as a dependency here as well. I hope it is a good idea.

Copy link
Member

Choose a reason for hiding this comment

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

Untested, but I "think" this is correct

@gziolo
Copy link
Member

gziolo commented Jan 28, 2020

@jsnajdr, I regenerated package-lock.json using the latest master version in
d19a844. I think we also need to define prettier as a dependency of @wordpress/scripts to make it work smoothly. Feel free to merge if you agree with the changes applied.

I tested locally with:

npm run lint-js
npm run format-js
npm run lint-js

There were 9 errors reported but they are caused by the next line disable comments no longer working as intended after file reformating.

@jsnajdr
Copy link
Member Author

jsnajdr commented Jan 29, 2020

I think we also need to define prettier as a dependency of @wordpress/scripts to make it work smoothly. Feel free to merge if you agree with the changes applied.

Thanks @gziolo! I think that Prettier doesn't necessarily need to be a dependency of @wordpress/scripts, but let's resolve this in followup discussions about the IDE integration and config files.

Now, let's merge this PR before it gets stale again! 🙂

@jsnajdr jsnajdr merged commit c2eece7 into master Jan 29, 2020
@gziolo
Copy link
Member

gziolo commented Jan 29, 2020

Awesome work @jsnajdr, thanks for bringing Prettier to the WordPress community 🎉

@ntwb
Copy link
Member

ntwb commented Jan 29, 2020

Woot 🥳

Thanks to everyone who contributed along the way, your feedback and patience is greatly appreciated 💯

Special shoutout and thanks @jsnajdr for maintaining, persisting, and persevering for the longest time to bring this to the WordPress project 🙇🏼‍♂️

@gziolo
Copy link
Member

gziolo commented Jan 29, 2020

I opened #19946 that document this new script added to @wordpress/scripts. @jsnajdr, can you double-check the proposal? Feel free to add your own commits if you feel like it needs more details. I omitted the part about IDEs as it feels like we need to experiment with it a bit first.

],
},
],
extends: [ require.resolve( './recommended-with-formatting.js' ), 'eslint-config-prettier' ],
Copy link
Contributor

Choose a reason for hiding this comment

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

We need to run prettier on lint if we are not going to enforce the formatting rules through eslint anymore.

@ellatrix ellatrix mentioned this pull request Jan 31, 2020
6 tasks
@epiqueras epiqueras added this to the Gutenberg 7.4 milestone Feb 3, 2020
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 <[email protected]>

* 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 <[email protected]>

Co-authored-by: Jorge Bernal <[email protected]>

* 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 <[email protected]>

* 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 <[email protected]>

* [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 <[email protected]>

* 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 <[email protected]>

* Fix extra newlines

* Standardize on Contributor Guide, matches core handbook

* Update manifest

Co-authored-by: Chris Van Patten <[email protected]>

* [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 <[email protected]>

* 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 <[email protected]>

* 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 <[email protected]>

* 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 9c1c71d25eb573427ca09761bd3154286d19539b.

* 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 <[email protected]>

Co-authored-by: Marcus Kazmierczak <[email protected]>

* 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 <[email protected]>

* 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 <[email protected]>

* Apply suggestions from code review

Thanks for the review and updates 👍

Co-Authored-By: Grzegorz (Greg) Ziółkowski <[email protected]>

Co-authored-by: Grzegorz (Greg) Ziółkowski <[email protected]>

* 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: 722a4d6dec

* 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 <[email protected]>

Co-authored-by: Andrew Duthie <[email protected]>

* 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 <[email protected]>

Co-authored-by: Andrew Duthie <[email protected]>

* 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 <[email protected]>

* Import useRef from @wordpress/element

* Fix lint

* Fix lint / prettier

Co-authored-by: Gerardo Pacheco <[email protected]>

* [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 <[email protected]>
Co-authored-by: Andrew Duthie <[email protected]>
Co-authored-by: Glen Davies <[email protected]>
Co-authored-by: Christopher Reece <[email protected]>
Co-authored-by: Marcus Kazmierczak <[email protected]>
Co-authored-by: Ella van Durpe <[email protected]>
Co-authored-by: Jorge Costa <[email protected]>
Co-authored-by: Bernie Reiter <[email protected]>
Co-authored-by: Jorge Bernal <[email protected]>
Co-authored-by: andrei draganescu <[email protected]>
Co-authored-by: Omar Alshaker <[email protected]>
Co-authored-by: Riad Benguella <[email protected]>
Co-authored-by: Damián Suárez <[email protected]>
Co-authored-by: Grzegorz (Greg) Ziółkowski <[email protected]>
Co-authored-by: Bart Kalisz <[email protected]>
Co-authored-by: Jon Quach <[email protected]>
Co-authored-by: Edi Amin <[email protected]>
Co-authored-by: Seghir Nadir <[email protected]>
Co-authored-by: Jerry Jones <[email protected]>
Co-authored-by: Matthew Kevins <[email protected]>
Co-authored-by: Abdelmajid HAMDANI <[email protected]>
Co-authored-by: Delowar Hossain <[email protected]>
Co-authored-by: Steven Dufresne <[email protected]>
Co-authored-by: Adam Boro <[email protected]>
Co-authored-by: Kukhyeon Heo <[email protected]>
Co-authored-by: Gerardo Pacheco <[email protected]>
Co-authored-by: etoledom <[email protected]>
Co-authored-by: Sérgio Estêvão <[email protected]>
Co-authored-by: Florian TIAR <[email protected]>
Co-authored-by: Chip <[email protected]>
Co-authored-by: Haz <[email protected]>
Co-authored-by: Rich Tabor <[email protected]>
Co-authored-by: Benjamin Intal <[email protected]>
Co-authored-by: Rostislav Wolný <[email protected]>
Co-authored-by: Chris Van Patten <[email protected]>
Co-authored-by: Luke Walczak <[email protected]>
Co-authored-by: Miguel Fonseca <[email protected]>
Co-authored-by: jbinda <[email protected]>
Co-authored-by: Leandro Alonso <[email protected]>
Co-authored-by: Jarda Snajdr <[email protected]>
Co-authored-by: Martin Posselt <[email protected]>
Co-authored-by: Ceyhun Ozugur <[email protected]>
Co-authored-by: James Newell <[email protected]>
Co-authored-by: Andy Peatling <[email protected]>
Co-authored-by: Andrew Serong <[email protected]>
Co-authored-by: Stephen Edgar <[email protected]>
@gziolo gziolo deleted the add/prettier branch May 28, 2020 09:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Code Quality Issues or PRs that relate to code quality [Type] Enhancement A suggestion for improvement. [Type] Technical Prototype Offers a technical exploration into an idea as an example of what's possible
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants