webdevstudios / js-coding-standards Goto Github PK

WebDevStudios JavaScript Coding Standards

Home Page: https://www.npmjs.com/package/@webdevstudios/js-coding-standards

js-coding-standards's Introduction

WebDevStudios JavaScript Coding Standards

This package is DEPRECATED and no longer in use at WebDevStudios and will no longer be maintained.

How to Install

npm install @webdevstudios/js-coding-standards --save-dev

In your package.json, you can add:

"eslintConfig": {
    "extends": "@webdevstudios/js-coding-standards"
}

To modify package.json quickly using jq use:

echo $( npx jq '.eslintConfig = {"extends": "@webdevstudios/js-coding-standards"}' package.json ) | npx jq . > package-tmp.json && mv package-tmp.json package.json

Changelog

See Releases...

js-coding-standards's People

Contributors

Stargazers

Watchers

Forkers

isabella232

js-coding-standards's Issues

Need to add a config file

Adding a .eslintrc file (for global installs) would be nice.

Bump eslint-plugin to >3.0

https://github.com/WebDevStudios/eslint-config-js-coding-standards/blob/master/package.json#L21

@michealengland had an issue where he was getting the error:

Oops! Something went wrong! :(
ESLint: 7.20.0
TypeError: Cannot read property 'name' of undefined
Occurred while linting /Users/mikeengland/Local Sites/care/app/public/wp-content/plugins/care-blocks/src/blocks/three-column-post-cards/post-search-input/index.js:451
    at /Users/mikeengland/Local Sites/care/app/public/wp-content/plugins/care-blocks/node_modules/@wordpress/eslint-plugin/rules/no-base-control-with-label-without-id.js:11:29
    at Array.some (<anonymous>)
    at containsAttribute (/Users/mikeengland/Local Sites/care/app/public/wp-content/plugins/care-blocks/node_modules/@wordpress/eslint-plugin/rules/no-base-control-with-label-without-id.js:10:29)
    at JSXOpeningElement[name.name='BaseControl'] (/Users/mikeengland/Local Sites/care/app/public/wp-content/plugins/care-blocks/node_modules/@wordpress/eslint-plugin/rules/no-base-control-with-label-without-id.js:15:6)
    at /Users/mikeengland/Local Sites/care/app/public/wp-content/plugins/care-blocks/node_modules/eslint/lib/linter/safe-emitter.js:45:58
    at Array.forEach (<anonymous>)
    at Object.emit (/Users/mikeengland/Local Sites/care/app/public/wp-content/plugins/care-blocks/node_modules/eslint/lib/linter/safe-emitter.js:45:38)
    at NodeEventGenerator.applySelector (/Users/mikeengland/Local Sites/care/app/public/wp-content/plugins/care-blocks/node_modules/eslint/lib/linter/node-event-generator.js:256:26)
    at NodeEventGenerator.applySelectors (/Users/mikeengland/Local Sites/care/app/public/wp-content/plugins/care-blocks/node_modules/eslint/lib/linter/node-event-generator.js:285:22)
    at NodeEventGenerator.enterNode (/Users/mikeengland/Local Sites/care/app/public/wp-content/plugins/care-blocks/node_modules/eslint/lib/linter/node-event-generator.js:299:14)

When running node_modules/.bin/eslint...

When troubleshooting we found the same issue here:

WordPress/gutenberg#17043

And solved the issue by bumping @wordpress/eslint-plugin first to ^8.0 and then to ~3.0 which both resolved the issue.. So we should try and widen the range of @wordpress/eslint-plugin to something that auto-updates a bit more gracefully.

Require arrays to be on new lines

		/**
		 * Each element of an array requires new line.
		 *
		 * @since Tuesday, 10/13/2020
		 *
		 * @see  https://eslint.org/docs/rules/array-element-newline
		 * @report Error
		 */
		'array-element-newline': [
			'error',
			'always',
		],

Example:

const a = [ 'one', 'two' ];

Would have to be:

const a = [ 
	'one', 
	'two',
];

This makes groking array's easier and ordering easier.

Need to update eslint to version @7 because @6 causes issues for VSCode not being able to find e.g. @wordpress/eslint-plugin

As you can see in the screenshot we have a project (usually at the wp-content level) open with a theme (wd_s) in the project. wd_s has it's own .eslintrc file that uses js-coding-standards. But eslint@6 (which comes from our coding standards) seems to have issues finding modules in the theme folder, and ultimately in the project folder. In the theme, if you install eslint@7 the problem is resolved and the theme eslint is able to find @wordpress/eslint-plugin in the nested theme/*/node_modules/* folder.

eslint encorcing a max-width

const accordionHeader = accordion.querySelector( '.accordion-item-header' );

		const accordionHeader = accordion.querySelector(
			'.accordion-item-header'
		);

eslint conflicting with prettier rule

			// If we're clicking on this accordion...
			if ( content.previousElementSibling === targetParent ) {
				// If it's already opened, close it. Otherwise, open it!
				if ( 'false' === content.getAttribute( 'aria-hidden' ) ) {
					content.setAttribute( 'aria-hidden', 'true' );
					content.parentElement.classList.remove( 'open' );
				} else {
					content.setAttribute( 'aria-hidden', 'false' );
					content.parentElement.classList.add( 'open' );
				}
			} else {
				content.setAttribute( 'aria-hidden', 'true' );
				content.parentElement.classList.remove( 'open' );
			}
		} );

Linter not always catching spacing

padding-blocks rule not working prolerly

https://github.com/WebDevStudios/eslint-config-js-coding-standards/blob/master/index.js#L277

According to https://eslint.org/docs/rules/padded-blocks

"always" (default) requires empty lines at the beginning and ending of block statements and classes
"never" disallows empty lines at the beginning and ending of block statements and classes

off is not an option.

multi-line arrays get formatted

Example:

const a = [
	itema,
	itemb,
];

Will be formatted, via Prettier, to:

const a = [ itema, itemb ];

...automatically:

@wordpress/scripts should also be linting — Due by October 02, 2020

@wordpress/scripts should also be linting

See WebDevStudios/wd_s#548

I think I need to work with @michealengland on this as I am not super-familiar with @wordpress/scripts and how we're using it on WDSCS.

Implement Prettier — Due by October 02, 2020

https://make.wordpress.org/core/2019/12/09/proposed-javascript-coding-standards-revisions-for-prettier-compatibility/

Sync with php-coding-standards

There are a lot of rules, such as @since, @author and @return that are not required in JS docblocks, etc. I wonder if maybe there are more like this that need to be synced up.

webdevstudios / js-coding-standards Goto Github PK

js-coding-standards's Introduction

WebDevStudios JavaScript Coding Standards

How to Install

Changelog

js-coding-standards's People

Contributors

Stargazers

Watchers

Forkers

js-coding-standards's Issues

Recommend Projects

Recommend Topics

Recommend Org