Back to Woocommerce

Enforce dependencies docblocks formatting (dependency-group)

packages/js/eslint-plugin/docs/rules/dependency-group.md

10.8.0-dev707 B
Original Source

Enforce dependencies docblocks formatting (dependency-group)

Ensures that all top-level package imports adhere to dependencies grouping conventions.

Specifically, this ensures that:

  • An import is preceded by "External dependencies" or "Internal dependencies" as appropriate by the import source.

Rule details

Examples of incorrect code for this rule:

js
import { get } from 'lodash';
import { Component } from '@wordpress/element';
import edit from './edit';

Examples of correct code for this rule:

js
/*
 * External dependencies
 */
import { get } from 'lodash';
import { Component } from '@wordpress/element';

/*
 * Internal dependencies
 */
import edit from './edit';