Skip to content

Latest commit

 

History

History
1226 lines (827 loc) · 60.9 KB

CHANGELOG.md

File metadata and controls

1226 lines (827 loc) · 60.9 KB
Raw

Changelog

46.0.0

Major Changes

45.0.0

Major Changes

  • #420 32e249f Thanks @BPScott! - Update required eslint version to ^8.56.0 as required by the newest version of @typescript-eslint/eslint-plugin.

    Update required node version to 18.20.0 as required by the newest version of @typescript-eslint/eslint-plugin.

    The jest/no-if rule has been removed and replaced with jest/no-conditional-in-test.

    The unicode-bom rule is no longer turned off if you enable the prettier ruleset per eslint-config-prettier, prettier preserves the bom value if it is present and does not add one if missing.

    Update eslint plugins to new versions:

    • @typescript-eslint/eslint-plugin: ^6.2.1 -> ^7.9.0 MAJOR
    • eslint-config-prettier: ^8.10.0 -> ^9.1.0 MAJOR
    • eslint-plugin-jest: ^27.2.3 => ^28.5.0 MAJOR
    • eslint-plugin-jsx-ally: ^6.7.1 => ^6.8.0
    • eslint-plugin-prettier: ^5.0.0 => ^5.1.3
    • eslint-plugin-react: ^7.33.1 => ^7.34.1
    • eslint-plugin-react-hooks: ^4.6.0 => ^4.6.2
    • eslint-plugin-sort-class-members: ^1.18.0 => ^1.20.0

    See package changelogs for breaking change information:

44.0.0

Major Changes

  • #409 4fd9e99 Thanks @jas7457! - Change the @typescript-eslint/consistent-indexed-object-style rule to use default error settings, aka Record over index signature

43.0.0

Major Changes

42.1.0

Minor Changes

  • #371 3e31042 Thanks @laurkim! - Updated component URLs for polaris.shopify.com and updated polaris-no-bare-stack-item to support LegacyStack and polaris-prefer-sectioned-prop to support LegacyCard'

42.0.3

Patch Changes

42.0.2

Patch Changes

  • #350 06e1245 Thanks @marvinhagemeister! - Update the eslint-plugin-import to the latest version which contains significant performance improvements for module resolution.

42.0.1

Patch Changes

  • #341 8cbfc69 Thanks @BPScott! - Update eslint-plugin-prettier to v4.1.0, to automatically skip trying to run prettier over graphql files. Remove the explicit override for disabling prettier in graphql files, as it will cause eslint's "work out what extensions need linting" logic to try to parse graphql files. Add {overrides: {files: ['*.graphql', '*.gql'], rules: {'prettier/prettier': 'off'}}} to your eslint config if want to disable running the prettier rule over graphql files entirely.

42.0.0

Major Changes

  • #340 af6fccc Thanks @BPScott! - Remove the @shopify/eslint-plugin/graphql config and the dependency on eslint-plugin-graphql as it is outdated and unsupported. If you used the graphql config then you should migrate to @graphql-eslint/eslint-plugin. We no longer provide recommended graphql config as it has a large install footprint and we do not want to push that onto consumers that do not use graphql.

Patch Changes

  • #338 d8c61cc Thanks @BPScott! - Remove a layer of indirection by specifying rules in lib/config/*.js files instead of having them import content from lib/config/rules/*.js

41.3.1

Patch Changes

41.3.0 - 2022-05-30

Changed

  • Update eslint-plugin-react dependency to ^7.30.0. Fix breakages by no longer reaching into eslint-plugin-react's internals. [#332]

41.2.1 - 2022-04-04

Changed

  • Allow usage of q variable in id-length rule [#329]

41.2.0 - 2022-03-07

Changed

  • Fixed conflicting dependency on eslint by upgrading eslint-plugin-promise to 6.0.0. [#325]

41.1.0 - 2022-02-01

Changed

  • Removed lines-around-comment rule, let prettier handle formatting of comments. [#319]

41.0.1 - 2021-12-02

Changed

41.0.0 - 2021-12-01

Breaking Change

  • Updated peer dependency on eslint to require at least v8.3.0. [#305]
  • Replaced usage of the long-deprecated babel-eslint and eslint-plugin-babel with @babel/eslint-parser and @babel/eslint-plugin. [#305]
  • Updated the minimum version of several eslint plugins. [#305]
Package Old version New version
typescript-eslint/eslint-plugin ^4.28.2 ^5.4.0
typescript-eslint/parser ^4.28.2 ^5.4.0
eslint-plugin-import ^2.23.4 ^2.25.3
eslint-plugin-jest ^24.3.6 ^25.3.0
eslint-plugin-jest-formatting ^3.0.0 ^3.1.0
eslint-plugin-jsx-a11y ^6.4.1 ^6.5.0
eslint-plugin-prettier ^3.4.0 ^4.0.0
eslint-plugin-promise ^5.1.0 ^5.1.1
eslint-plugin-react ^7.24.0 ^7.27.1
eslint-plugin-react-hooks ^4.2.0 ^4.3.0
eslint-plugin-sort-class-members ^1.11.0 ^1.14.0

Changed

  • Update env and ecmaVersion to '2021' in esnext andtypescript presets to support modern language features. [#296, #304]
  • Remove configuring parserOptions from the jest preset as this handled by the the es5/esnext/typescript presets. [#304]
  • Removed dependency on merge by replacing usage with object spread. [#308]

40.5.0 - 2021-11-18

Changed

  • Loosen semver restrictions on eslint plugins. [#297]

40.4.0 - 2021-07-12

Changed

  • Update eslint and plugin dependencies. [#272]

40.3.0 - 2021-06-30

Changed

  • Removed jsx-a11y/autocomplete-valid rule for eslint-plugin. [#264]
  • Add react-require-autocomplete lint rule to @shopify/eslint-plugin. [#251]

40.2.3 - 2021-05-10

Changed

  • Fix conflicting @typescript-eslint/naming-convention rules. [#247]

40.2.2 - 2021-05-05

Changed

  • Update merge to 2.1.1. [#244]

40.2.1 - 2021-04-16

Changed

  • Fixed a conflict between Prettier and rules */object-curly-spacing. [#227]

40.2.0 - 2021-04-16

Changed

  • Added jsx-a11y/autocomplete-valid rule for eslint-plugin. [#217]
  • Updated @typescript-eslint/parser and @typescript-eslint/eslint-plugin to version 4.20.0. [#223]

40.1.0 - 2021-02-24

Changed

  • Include jest formatting in @shopify/eslint-plugin ruleset. [#213]

40.0.1 - 2021-02-12

Changed

  • Fix incompatibility between @typescript-eslint/array-type and @typescript-eslint/ban-types. [#212]

40.0.0 - 2021-02-12

Changed

  • Updated eslint-plugin test to prepare for eslint@7 upgrade. [#211]

Breaking Change

  • Updated eslint-plugin plugins and removed support for eslint@6. [#194]
Package Old version New version
eslint-config-prettier 6.14.0 7.2.0
eslint-plugin-jest-formatting 2.0.0 2.0.1
eslint-plugin-promise 4.2.1 4.3.1
eslint-plugin-jest 24.1.0 24.1.3
eslint-plugin-react 7.21.5 7.22.0
eslint-plugin-sort-class-members 1.8.0 1.9.0
@typescript-eslint/eslint-plugin 4.1.0 4.15.0
@typescript-eslint/parser 4.1.0 4.15.0
change-case 4.1.0 4.1.2

39.0.4 - 2021-01-13

Changed

  • Updated TypeScript naming rules to ensure type name start with a "T" and interface names don't start with an "I". [#198]
  • Updated eslint-config-prettier dependency to v3.3.0. [#202]

39.0.3 - 2020-11-17

Fixed

  • Fixed a syntax error in peerDependencies to allow eslint@^7.0.0. [#196]

39.0.2 - 2020-11-03

Fixed

  • Add support for CommonJS in prefer-module-scope-constants. [#195]

Changed

  • Updated eslint-plugin plugins. [#194]
Package Old version New version
eslint-config-prettier 6.11.0 6.14.0
eslint-plugin-jsx-a11y 6.3.1 6.4.1
eslint-plugin-import 2.22.0 2.22.1
eslint-plugin-jest 24.0.0 24.1.0
eslint-plugin-react 7.20.6 7.21.5
eslint-plugin-react-hooks 4.1.1 4.1.2

39.0.0 - 2020-09-17

Breaking Change

  • Added id field to graphql/required-fields rule. [#166]

Updated Plugins

Package Old version New version
@typescript-eslint/eslint-plugin 3.9.1 4.1.0
@typescript-eslint/parser 3.9.1 4.1.0
eslint-plugin-babel 5.3.0 5.3.1
eslint-plugin-eslint-comments 3.1.2 3.2.0
eslint-plugin-graphql 3.1.1 4.0.0
eslint-plugin-jest 23.13.0 24.0.0
eslint-plugin-jsx-a11y 6.2.3 6.3.1
eslint-plugin-node 3.1.3 3.1.4
eslint-plugin-react 7.20.0 7.20.6
eslint-plugin-react-hooks 4.0.2 4.1.1
eslint-plugin-sort-class-members 1.7.0 1.8.0

38.0.0

Added

  • Created a new rule, @shopify/typescript/prefer-build-client-schema. [#176]

Breaking Change

  • Dropping eslint-plugin-typescript and upgrading @typescript-eslint/eslint-plugin from 2.33.0 to 3.9.1. The update brings breaking changes from the version 3 release of @typescript-eslint/eslint-plugin.

  • Removal of @typescript-eslint/class-name-casing and @typescript-eslint/camelcase for @typescript-eslint/naming-convention. Please update your ignore statements.

  • Removal of @typescript-eslint/ban-ts-ignore for @typescript-eslint/ban-ts-comment. Please update your ignore statements.

37.0.0 - 2020-05-19

Added

The following new rules were introduced. More information can be found. [#157]

Facebook improved the eslint-plugin-react-hooks plugin. We may have to update the dependencies of some hooks.

Updated Plugins

Package Old version New version
@typescript-eslint/eslint-plugin 2.25.0 2.33.0
@typescript-eslint/parser 2.25.0 2.33.0
babel-eslint 10.0.3 10.1.0
change-case 4.0.1 4.1.1
eslint-config-prettier 6.7.0 6.11.0
eslint-module-utils 2.5.0 2.6.0
eslint-plugin-graphql 3.1.0 3.1.1
eslint-plugin-import 2.19.1 2.20.2
eslint-plugin-jest 23.7.0 23.13.0
eslint-plugin-node 10.0.0 11.1.0
eslint-plugin-prettier 3.1.2 3.1.3
eslint-plugin-react 7.17.0 7.20.0
eslint-plugin-react-hooks 2.3.0 4.0.2
eslint-plugin-sort-class-members 1.6.0 1.7.0
merge 1.2.1 1.2.1
pkg-dir 4.2.0 4.2.0

36.1.0 - 2020-05-05

  • adding allow and maxDepth options to strict-component-boundaries rule. [#150]

36.0.1 - 2020-03-28

  • Fix an bug with '@shopify/react-no-multiple-render-methods'.

36.0.0 - 2020-03-28

Breaking Change

🚨Package rename

This package has been renamed from eslint-plugin-shopify to @shopify/eslint-plugin. You must update you eslint config to account for the new name, when referencing the plugin and individual rules.

Before:

plugins: ['shopify'],
extends: ['plugin:shopify/'],
rules: {
  'shopify/...': 'off',
}

After:

plugins: ['@shopify'],
extends: ['plugin:@shopify/...'],
rules: {
  '@shopify/...': 'off',
}

35.1.0 - 2020-03-23

  • Update @typescript-eslint/eslint-plugin and @typescript-eslint/parser to 2.25.0, to support new syntax introduced in Typescript 3.8. [#523]

35.0.0 - 2020-02-14

  • remove no-vague-titles because the rule was adopted into eslint-plugin-jest's valid-title rule. See the valid-title documentation
  • Fixed an issue with typescript/prefer-pascal-case-enum when you had enum with key as string. [#517]

34.0.1 - 2019-01-13

  • fix enabled graphql rules by specifying env: 'literal'. [#514]

34.0.0 - 2019-01-13

  • changed no-vague-titles rule to catch blacklisted words (instead of sequences) in the title. [#514]
  • removed jest/no-empty-title and renamed jest/require-tothrow-message to jest/require-to-throw-message. [#499]

Added

The followiing new rules were introduced in [email protected]. More information can be found on the eslint blog.

33.0.0 - 2019-11-20

Breaking Change

  • The graphql configs have been pushed to an override for files matching a .graphql extension. This will allow this config to chain together with other parser-setting configs without changing the parser value. Consider the following config:
// .eslintrc
{
  extends: [
    "plugin:shopify/typescript",
    "plugin:shopify/graphql"
  ]
}

Before this change the final parser becomes babel-eslint for all files. This will cause errors when parsing TypeScript files even though we are extending the typescript config :( You could workaround this by moving the plugin:shopify/graphql first in the extends array or lint GraphQL files in a seperate script.

After this change Final parser is babel-eslint for only .graphql files while @typescript-eslint/parser is set for all .ts and .tsx files. This should not cause any parser-related errors :)

Added

  • shopify/no-all-mocks-methods. [#204]
  • shopify/no-namespace-imports Prevent namespace import declarations. [#262]

32.0.0 - 2019-11-05

  • jest/valid-title
  • jest/prefer-hooks-on-top
  • jest/require-top-level-describe
  • Enforce new-lines between groups import groups. [#409]

31.0.0 - 2019-10-23

Breaking Change

  • Breaking Change Updated from eslint-plugin-typescript to @typescript-eslint/eslint-plugin. If you have any rules defined under the typescript namespace, you will need to change those to use the new @typescript-eslint namespace.

For example:

"rules": {
  "typescript/restrict-plus-operands": "error"
}

Will become:

"rules": {
  "@typescript-eslint/restrict-plus-operands": "error"
}
  • Breaking Change The plugin:shopify/react is no longer a core config and must augment one of the plugin:shopify/typescript or plugin:shopify/esnext configs. See examples below

Example config for react without typescript projects:

{
  "extends": [
    "plugin:shopify/esnext",
    "plugin:shopify/react"
    // ...other configs
  ]
}

Example config for react with typescript projects:

{
  "extends": [
    "plugin:shopify/typescript",
    "plugin:shopify/react"
    // ...other configs
  ]
}
  • Note If using the plugin:shopify/typescript-type-checking augmented config, you must specify a path to your tsconfig.json file in the "project" property of "parserOptions"

Added

  • jest/no-standalone-expect Prevents expect statements outside of a test or it block. [#368]
  • jest/no-expect-resolves Avoid using expect().resolves. [#370]

30.0.1 - 2019-06-24

  • bump eslint peer depndency to 6

30.0.0 - 2019-06-24

Changed

  • Enabled jest/no-export rule. [#344]
  • [Major] depreciated shopify/jest/no-try-expect in favour of jest/no-try-expect. [#331]
  • [Major] depreciated shopify/jest/no-if in favour of jest/no-if. [#347]
  • [Major] Updated to eslint v6, enabled no-console and enabled no-async-promise-executor. [#330]
  • Enabled typescript/interface-name-prefix to prevent I prefixes in TypeScript interface names
  • Enabled jest/no-duplicate-hooks rule. [#344]

Fixed

  • [Patch] Fix jest/no-if from falsely reporting if statements inside of functions. [#331]

29.0.2 - 2019-06-18

Changed

  • Removed react/prop-types in typescript config. [#309]

29.0.1 - 2019-06-18

Changed

  • Removed import/no-namespace. [#308]

29.0.0 - 2019-06-17

Changed

  • added "necessary" to shopify/jest/no-vague-titles. [#265]
  • shopify/jest/no-if now recognizes conditional statements. [#298]

Added

  • New Rules:
    • jest/no-commented-out-tests disallows commented out tests. [#275]
    • jest/no-try-expect disallows expect calls in catch blocks. [#300]
    • node/prefer-promises/dns and node/prefer-promises/fs These rules disallow the callback API in favor of promise API for the dns and fs modules. [#257]
    • jest/no-mocks-import This rule disallows manually importing from __mocks__. [#246]
    • react/state-in-constructor Enforce state initialization to be in a class property. [#256]
    • import/no-namespace Prevents namespace imports. [#305]

Fixed

  • shopify/jest/no-if ignores if statements nested within block statements. [#299]
  • react-prefer-private-members from incorrectly reporting the members of a parent class if a React class is defined within its constructor. [#258]

28.0.0 - 2019-04-26

Changed

  • Reverted a previous update from eslint-plugin-typescript to @typescript-eslint/eslint-plugin. If you have any rules defined under the @typescript-eslint namespace, you will need to change those to use the older typescript namespace.

    For example:

    "rules": {
  "@typescript-eslint/restrict-plus-operands": "error"
}

    Will become:

    "rules": {
  "typescript/restrict-plus-operands": "error"
}

Note: This is a temporary work-around to resolve a bug in prettier-eslint and will attempt the typescript updates again when resolved.

Fixed

  • shopify/restrict-full-import "empty" array pattern (eg: const [, bar] = foo errors. [#243]
  • Optimized shopify/images/no-direct-imports to be much faster in the common case. [#247]
  • shopify/react-hooks-strict-return from crashing when a hook returns undefined. [#251]

Added

  • updated eslint-plugin-import to version 22.4.1 which introduces the no-unused-modules rule.
  • updated eslint-plugin-jest to version 22.4.1 which introduces the no-empty-title rule.
  • shopify/react-hooks-strict-return Restrict the number of returned items from React hooks. [#237]

Removed

  • turned off node/no-extraneous-require because it duplicates reported violations from import/no-extraneous-dependencies. [#240]

27.0.1 - 2019-04-10

Changed

  • shopify/jest/no-if no longer considers if statements in describe blocks as invalid. [#235]

Removed

  • turned off consistent-return. [#236]
  • turned off react/jsx-no-bind. [#239]
  • turned off babel/camelcase in typescript config because it overlaps with @typescript-eslint/camelcase. [#238]
  • shopify/jest/no-if no longer considers if statements in describe blocks as invalid. [#235]

27.0.0 - 2019-04-08

Added

Plugin updates and additions. [#233]

Breaking Changes

  • shopify/jquery-dollar-sign-reference has been removed.

  • The eslint-comments ruleset has been removed and is now enabled by default as part of core - if you're using es5, esnext, react or typescript then you can remove the reference to eslint-comments.

  • The ava, mocha, jquery and lodash rulesets have been removed as these tools are are not commonly used at Shopify.

  • The typescript-react and typescript-prettier rulesets have been removed. Replace ["plugin:shopify/typescript-react"] with ["plugin:shopify/typescript", "plugin:shopify/react"] and replace["plugin:shopify/typescript-prettier"] with ["plugin:shopify/prettier"]

  • Updated from eslint-plugin-typescript to @typescript-eslint/eslint-plugin. If you have any rules defined under the typescript namespace, you will need to change those to use the new @typescript-eslint namespace.

    For example:

    "rules": {
  "typescript/restrict-plus-operands": "error"
}

    Will become:

    "rules": {
  "@typescript-eslint/restrict-plus-operands": "error"
}

    More information on this change can be found in this eslint blog post.

Added

  • shopify/jest/no-if. [#232]

Refer to the Rules of Hooks documentation to learn more about the following rules.

  • 'react-hooks/rules-of-hooks': 'error' // Only use Hooks at the top level of a React functional component or from within another custom hook.
  • 'react-hooks/exhaustive-deps': 'error' // Checks for missing useEffect dependencies

Updated Plugins

Package Old version New version
eslint-plugin-sort-class-members 1.3.1 1.4.0
eslint-plugin-promise 4.0.0 4.0.1
eslint-plugin-node 7.0.1 8.0.1
eslint-plugin-jsx-a11y 6.1.1" 6.2.1
eslint-plugin-jest 21.22.0 21.23.0
eslint-plugin-import 2.14.0 2.16.0
eslint-plugin-graphql 2.1.0-0 3.0.3
eslint-plugin-eslint-comments 3.0.1 3.1.1
eslint-plugin-babel 5.1.0 5.3.0
eslint-plugin-utils 2.1.0 2.3.0

Added Plugins

Package Version
eslint-plugin-react-hooks 1.5.0
@typescript-eslint/eslint-plugin 1.5.0
"@typescript-eslint/parser 1.5.0
babel-eslint 10.0.1

Removed Plugins

Package
eslint-plugin-mocha
eslint-plugin-ava
eslint-plugin-flowtype
eslint-plugin-chai-expect
eslint-plugin-lodash
eslint-plugin-jquery

Changed

  • jest/no-vague-titles added every and descriptive as vague words. [#221]

26.3.0 - 2019-02-21

Added

  • Updated eslint-plugin-react and enabled react/jsx-fragments rule to prefer using <> over <React.Fragment> when defining fragments. [#223]

26.2.0 - 2019-02-14

Added

  • images-no-direct-imports. [#219]

26.1.2 - 2019-01-02

Fixed

  • jest/no-vague-titles no longer flags when the word call is used. [#203]
  • Update eslint-plugin-prettier to 3.0.1 so it does not crash when given an unparsable file. [#212]

Changed

  • jest/no-vague-titles added should and properly to vague rules and new configuration to allow words. [#208]

26.1.1 - 2018-10-31

Fixed

26.1.0 - 2018-10-30

Added

  • shopify/no-ancestor-directory-import. [#149]

Fixed

  • Set TypeScript parser only on TS files. This makes sure you can extend from the typescript and react configs in either order. Previously you had to make sure typescript came first to avoid using the babel-eslint parser on typescript files. Now we suggest to extend from typescript, and then react to ensure some rules some JSX rules don't get inadventently disabled. [#200]

26.0.0 - 2018-10-26

Added

  • shopify/eslint-comments plugin with eslint-plugin-eslint-comments rules:

    • eslint-comments/disable-enable-pair,
    • eslint-comments/no-aggregating-enable
    • eslint-comments/no-duplicate-disable
    • eslint-comments/no-unlimited-disable
    • eslint-comments/no-unused-disable
    • eslint-comments/no-unused-enable
    • eslint-comments/no-restricted-disable (disabled)
    • eslint-comments/no-use (disabled)

  • shopify/jest/no-snapshots. [#182]

Changed

  • Updated plugin:shopify/prettier, plugin:shopify/react, and plugin:shopify/typescript to use overrides. [#173]
  • Updated import/order rule to enforce ordering of internal, parent and sibling imports. [#189]
  • Updated func-style rule to allow arrow functions. [#188]

Fixed

  • Rolling back eslint-plugin-graphql to 2.1.0-0 for multiple schema support. [#195]

25.1.0 - 2018-10-01

Changed

  • Updated typescript-eslint-parser dependency to version 19.0.2 to support typescript-estree. [#176]

25.0.1 - 2018-09-25

Fixed

  • Restored typescript-prettier config to override prettier plugin parser. [#171]

25.0.0 - 2018-09-25

Fixed

  • Updated plugin:shopify/prettier to enable prettier linting. [#170]
  • strict-component-boundaries now consistently uses the resolved path from the app root to perform its checks. This fixes a number of false-positives. [#160]

24.2.0 - 2018-09-21

Added

  • Added plugin:shopify/graphql to module index. [#168]

Fixed

  • Updated no-vague-titles rule to fix parsing issues in getMethodName. [#167]

24.1.1 - 2018-09-19

  • Same as 24.1.0

24.1.0 - 2018-09-19

Added

  • Added shopify/graphql config using new eslint-plugin-graphql (2.1.1.) dependency. [#165]

24.0.0 - 2018-08-30

Fixed

  • plugin:shopify/flow now disables rules checked by Flow's static analyzer. [#135]
  • plugin:shopify/prettier and plugin:shopify/typescript-prettier defer missing semicolon rules to a project´s .prettierrc. [#135]
  • Updated strict-component-boundaries to exclude fixture imports. [#117]
  • Updated strict-component-boundaries to exclude imports from node_modules. [#140]
  • Updated jest/no-vague-titles to support .each syntax. [#148]

Changed

  • Namespaced prefer-pascal-case-enums and prefer-singular-enums under typescript. [#141]
  • Breaking: Updated to eslint v5.4.0. Consuming projects must be using supported node versions, we recommend ^8.10.0. See details on the v4 to v5 migration guide. [#151]

Added

23.1.0 - 2018-08-02

Fixed

  • Updated typescript-eslint-parser dependency to version 17.0.1 in order to support TypeScript 3. [#121]
  • Removed default prettier configurations. plugin:shopify/prettier and plugin:shopify/typescript-prettier now defer Prettier's config to a project's .prettierrc. [#121]

Changed

  • Included all as a vague term for no-vague-titles. [#114]

23.0.0 - 2018-07-16

  • Breaking eslint-plugin-shopify will no longer install prettier as a dependency. Please ensure you have added prettier to your package.json if you wish to use it.

Added

  • shopify/jsx-prefer-fragment-wrappers. [#94]
  • shopify/jest/no-vague-titles. [#93]
  • shopify/strict-component-boundaries. [#98]

Changed

  • Breaking Moved prettier to be a peerDependency, this avoids the potential for having multiple versions of prettier in the dependency graph. If you use prettier you will need to ensure you have it installed in your project as eslint-plugin-shopify will no longer install it for you. [#107]
  • Breaking Updated typescript-eslint-parser to support [email protected]. [#102]

22.1.0 - 2018-06-08

Fixed

  • Updated eslint-plugin-sort-class-members dependency to version 1.3.1 in order to support node 10.

Added

  • shopify/prefer-pascal-case-enums. [#96]
  • shopify/react-prefer-private-members. [#95]

22.0.0

  • Updated dependencies
  • Added support for TypeScript 2.8

21.0.1 - 2018-04-25

  • Fixed the publish config for the package.

21.0.0 - 2018-04-25

Added

  • shopify/jsx-no-hardcoded-content now accepts a dom option that allows specifying attributes on DOM elements and Web Components to be checked for hardcoded content.

Removed

  • Breaking: turned off four rules that previously triggered errors in all cases:
    • shopify/react-type-state (TypeScript now addresses the issue this rule was meant to catch)
    • promise/always-return
    • react/no-did-mount-set-state
    • no-undefined
  • Breaking: turned off two rules in specific plugins:
    • babel/no-invalid-this (turned off for the typescript configs as TypeScript has better mechanisms for unsuring a valid this is used)
    • no-process-env (turned off for the webpack and node configs as both targets can benefit from use of process.env)

Fixed

  • Fixed an issue where various rules were not correctly resolving paths in node_modules.

20.0.0 - 2018-03-15

  • Breaking: the version of TypeScript supported by this plugin is 2.7.x (in line with typescript-eslint-parser’s TypeScript support)
  • Updated dependencies that support the new ESLint documentation URL metadata. Errors from these plugins are accompanied by a link to the documentation for the broken rule.
  • Dependencies are now strictly versioned for tighter control over the exact rules the plugin enforces.
Package old new
eslint-plugin-ava ^4.4.0 4.5.1
eslint-plugin-import ^2.8.0 2.9.0
eslint-plugin-jest ^21.5.0 21.14.1
eslint-plugin-lodash ^2.5.0 2.6.1
eslint-plugin-node ^5.2.1 6.0.1
eslint-plugin-prettier ^2.4.0 2.6.0
eslint-plugin-promise ^3.6.0 3.7.0
eslint-plugin-react ^7.5.1 7.7.0
eslint-plugin-typescript ^0.8.1 0.10.0

19.0.1 - 2018-03-12

Fixed

  • shopify/jsx-no-hardcoded-content rule now does not warn on all-whitespace strings as children. This was causing issues with indented JSX content, and is typically not an issue for different locales.

19.0.0 - 2018-01-17

Added

Changed

  • Updated dependencies to their latest versions (full details in #63)

  • Breaking: node.js minimum supported node version update to 8.9.4 (LTS).

  • Breaking: Changed eslint-config-shopify codebase to trailingComma: 'all' and drop support for Node.js 6

  • Breaking: Updated prettier to 1.9.2, introducing a change in function parens style (set to arrowParens: 'always'):

    // Before
const foo = myArray.map((foo) => {});

// After
const foo = myArray.map((foo) => {});

    ⚠️ Upgrade path:

    Your project config files (package.json, .prettierrc, .eslintrc…) may need to be updated like so:

       "singleQuote": true,
   "bracketSpacing": false,
   "trailingComma": "all",
+  "arrowParens": "always"

  • Prettified source files using the new config

18.3.1 - 2017-12-21

Changed

  • Changed eslint-config-shopify codebase to follow es5 trailingComma. [#61]

18.3.0 - 2017-12-18

Added

  • Added shopify/no-debugger, which behaves the same as ESLint's no-debugger but without a fixer.

18.2.0 - 2017-12-04

Added

  • Added a typescript-prettier config to run prettier against typescript projects.

18.1.0 - 2017-12-01

Added

  • Added a typescript and typescript-react config. [#54]

Changed

  • plugin:shopify/prettier will now enforce trailing commas in function parameter calls. [#55]

  • comma-dangle will now enforce multi-line function parameters. [#55]

  • Removed plugin:shopify/esnext as an included extension of the plugin:shopify/prettier config. plugin:shopify/esnext must now be extended by the consumer to use the plugin:shopify/prettier. [#53]

    Example (package.json):

    "eslintConfig": {
  "extends": [
    "plugin:shopify/esnext",
    "plugin:shopify/prettier"
  ]
}

18.0.0 - 2017-10-31

Changed

  • Turned off class-methods-use-this

17.2.1 - 2017-10-30

Changed

  • Turned off babel/semi rule in prettier config

17.2.0 - 2017-10-25

Added

  • Added a prettier config. [#46]

Example:

"eslintConfig": {
  "extends": [
    "plugin:shopify/prettier"
  ]
}

Changed

  • Replace all warn with error. [#48]
  • space-before-function-paren now uses asyncArrow option (eg. async () => {}). [#43]
  • Enable padding-line-between-statements for directives. [#44]

Removed

  • lines-around-directive was deprecated in ESLint v4.0.0. [#44]

17.1.0 - 2017-09-19

Added

  • New rules. [#41]:
    • import/no-anonymous-default-export
    • jsx-a11y/anchor-is-valid
    • no-buffer-constructor
    • node/no-extraneous-import (disabled)
    • node/no-extraneous-require
    • for-direction
    • getter-return
    • react/boolean-prop-naming (disabled)
    • react/default-props-match-prop-types
    • react/no-redundant-should-component-update
    • react/no-typos
    • react/no-unused-state
    • react/jsx-closing-tag-location
    • array-bracket-newline (disabled)
    • array-element-newline (disabled)
    • function-paren-newline
    • padding-line-between-statements (disabled)
    • semi-style
    • switch-colon-spacing

Changed

  • Updated dependencies. [#41]:
    • eslint
    • babel-eslint
    • eslint-plugin-import
    • eslint-plugin-jsx-a11y
    • eslint-plugin-node
    • eslint-plugin-react
  • jquery-dollar-sign-reference no longer flags assignments from await expressions

Removed

  • jsx-a11y/href-no-hash replaced with jsx-a11y/anchor-is-valid

17.0.0 - 2017-08-17

Changed

  • eslint upgrade to 4.3.0
  • node.js minimum supported node version update to 6.11.1 (LTS).
  • Update dependencies:
    • eslint-plugin-ava: ^4.2.0 → ^4.2.1.
    • eslint-plugin-babel: ^4.1.1 → ^4.1.2.
    • eslint-plugin-lodash: ^2.4.2 → ^2.4.4.
    • eslint-plugin-mocha: ^4.9.0 → ^4.11.0.
    • eslint-plugin-node: ^4.2.2 → ^4.2.3.
    • eslint-plugin-react: ^7.0.0 → ^7.0.1.

16.0.1 - 2017-05-29

Changed

16.0.0 - 2017-05-16

Added

Removed

15.2.0 - 2017-03-06

Changed

  • eslint upgrade to 3.17.x

15.1.2 - 2017-02-23

Fixed

  • jquery-dollar-sign-reference now checks assignments from LogicalExpression / BinaryExpression

15.1.1 - 2017-01-17

Added

  • Added eslint-index package. [#4]
  • Added rules-status and rules-omitted scripts. [#4]
  • Added new eslint-plugin-react rules: no-array-index-key, require-default-props. [#4]
  • Added new eslint-plugin-lodash rules: import-scope. [#4]
  • Added new eslint-plugin-promise rules: no-return-wrap, no-nesting, no-promise-in-callback, no-callback-in-promise, avoid-new, prefer-await-to-then, prefer-await-to-callbacks. [#4]

Changed

  • Updated eslint-plugin-flowtype, eslint-plugin-lodash, eslint-plugin-mocha, eslint-plugin-promise, eslint-plugin-react to their latest versions. [#4]
  • Updated react/prefer-stateless-function rule to include ignorePureComponents flag. [#4]

Removed

  • Removed eslint-find-rules package. [#4]

15.1.0

Changes were originally tracked in Shopify's JavaScript monorepo.