eslint-plugin-unicorn - npm Package Compare versions

Comparing version 11.0.2 to 12.0.0

index.js

@@ -58,2 +58,3 @@ 'use strict';
 				'unicorn/prefer-starts-ends-with': 'error',
+				'unicorn/prefer-string-slice': 'error',
 				'unicorn/prefer-text-content': 'error',
@@ -60,0 +61,0 @@ 'unicorn/prefer-type-error': 'error',

package.json

 {
 	"name": "eslint-plugin-unicorn",
-	"version": "11.0.2",
+	"version": "12.0.0",
 	"description": "Various awesome ESLint rules",
@@ -37,2 +37,3 @@ "license": "MIT",
 		"eslint-ast-utils": "^1.1.0",
+		"eslint-template-visitor": "^1.0.0",
 		"import-modules": "^1.1.0",
@@ -45,4 +46,4 @@ "lodash.camelcase": "^4.3.0",
 		"lodash.upperfirst": "^4.3.1",
+		"read-pkg-up": "^6.0.0",
 		"regexpp": "^3.0.0",
-		"read-pkg": "^5.2.0",
 		"reserved-words": "^0.1.2",
@@ -49,0 +50,0 @@ "safe-regex": "^2.0.2",

readme.md

@@ -76,2 +76,3 @@ # eslint-plugin-unicorn [![Build Status](https://travis-ci.org/sindresorhus/eslint-plugin-unicorn.svg?branch=master)](https://travis-ci.org/sindresorhus/eslint-plugin-unicorn) [![Coverage Status](https://coveralls.io/repos/github/sindresorhus/eslint-plugin-unicorn/badge.svg?branch=master)](https://coveralls.io/github/sindresorhus/eslint-plugin-unicorn?branch=master)
 			"unicorn/prefer-starts-ends-with": "error",
+			"unicorn/prefer-string-slice": "error",
 			"unicorn/prefer-text-content": "error",
@@ -127,2 +128,3 @@ "unicorn/prefer-type-error": "error",
 - [prefer-starts-ends-with](docs/rules/prefer-starts-ends-with.md) - Prefer `String#startsWith()` & `String#endsWith()` over more complex alternatives.
+- [prefer-string-slice](docs/rules/prefer-string-slice.md) - Prefer `String#slice()` over `String#substr()` and `String#substring()`. *(partly fixable)*
 - [prefer-text-content](docs/rules/prefer-text-content.md) - Prefer `.textContent` over `.innerText`. *(fixable)*
@@ -161,2 +163,3 @@ - [prefer-type-error](docs/rules/prefer-type-error.md) - Enforce throwing `TypeError` in type checking conditions. *(fixable)*
 - [Sam Verschueren](https://github.com/SamVerschueren)
+- [Fisker Cheung](https://github.com/fisker)
 
@@ -163,0 +166,0 @@ ###### Former

rules/expiring-todo-comments.js

 'use strict';
-const readPkg = require('read-pkg');
+const readPkgUp = require('read-pkg-up');
 const semver = require('semver');
@@ -20,3 +20,3 @@ const ci = require('ci-info');
 
-const pkg = readPkg.sync();
+const pkg = readPkgUp.sync().package;
 
@@ -293,3 +293,2 @@ const pkgDependencies = {
 			const compare = semverComparisonForOperator(condition);
-
 			if (compare(pkgVersion, desidedPkgVersion)) {
@@ -296,0 +295,0 @@ context.report({

rules/filename-case.js

@@ -8,2 +8,3 @@ 'use strict';
 const getDocsUrl = require('./utils/get-docs-url');
+const cartesianProductSamples = require('./utils/cartesian-product-samples');
 
@@ -14,2 +15,3 @@ const pascalCase = string => upperfirst(camelCase(string));
 const PLACEHOLDER_REGEX = new RegExp(PLACEHOLDER, 'i');
+const isIgnoredChar = char => !/^[a-z\d-_$]$/i.test(char);
 
@@ -79,15 +81,46 @@ function ignoreNumbers(fn) {
 
-function fixFilename(chosenCase, filename) {
-	return filename
-		.split('.')
-		.map(ignoreNumbers(cases[chosenCase].fn))
-		.join('.');
+function validateFilename(words, caseFunctions) {
+	return words
+		.filter(({ignored}) => !ignored)
+		.every(({word}) => caseFunctions.some(fn => fn(word) === word));
 }
 
+function fixFilename(words, caseFunctions, {leading, extension}) {
+	const replacements = words
+		.map(({word, ignored}) => ignored ? [word] : caseFunctions.map(fn => fn(word)));
+
+	const {
+		samples: combinations
+	} = cartesianProductSamples(replacements);
+
+	return combinations.map(parts => `${leading}${parts.join('')}${extension}`);
+}
+
 const leadingUnserscoresRegex = /^(_+)(.*)$/;
 function splitFilename(filename) {
 	const res = leadingUnserscoresRegex.exec(filename);
+
+	const leading = (res && res[1]) || '';
+	const tailing = (res && res[2]) || filename;
+
+	const words = [];
+
+	let lastWord;
+	for (const char of tailing) {
+		const isIgnored = isIgnoredChar(char);
+
+		if (lastWord && lastWord.ignored === isIgnored) {
+			lastWord.word += char;
+		} else {
+			lastWord = {
+				word: char,
+				ignored: isIgnored
+			};
+			words.push(lastWord);
+		}
+	}
+
 	return {
-		leading: (res && res[1]) || '',
-		trailing: (res && res[2]) || filename
+		leading,
+		words
 	};
@@ -118,2 +151,3 @@ }
 	const chosenCases = getChosenCases(context);
+	const chosenCasesFunctions = chosenCases.map(case_ => ignoreNumbers(cases[case_].fn));
 	const filenameWithExtension = context.getFilename();
@@ -134,16 +168,25 @@
 
-			const splitName = splitFilename(filename);
-			const fixedFilenames = chosenCases.map(case_ => fixFilename(case_, splitName.trailing));
-			const renamedFilenames = fixedFilenames.map(x => splitName.leading + x + extension);
+			const {
+				leading,
+				words
+			} = splitFilename(filename);
+			const isValid = validateFilename(words, chosenCasesFunctions);
 
-			if (!fixedFilenames.includes(splitName.trailing)) {
-				context.report({
-					node,
-					messageId: chosenCases.length > 1 ? 'renameToCases' : 'renameToCase',
-					data: {
-						chosenCases: englishishJoinWords(chosenCases.map(x => cases[x].name)),
-						renamedFilenames: englishishJoinWords(renamedFilenames.map(x => `\`${x}\``))
-					}
-				});
+			if (isValid) {
+				return;
 			}
+
+			const renamedFilenames = fixFilename(words, chosenCasesFunctions, {
+				leading,
+				extension
+			});
+
+			context.report({
+				node,
+				messageId: chosenCases.length > 1 ? 'renameToCases' : 'renameToCase',
+				data: {
+					chosenCases: englishishJoinWords(chosenCases.map(x => cases[x].name)),
+					renamedFilenames: englishishJoinWords(renamedFilenames.map(x => `\`${x}\``))
+				}
+			});
 		}
@@ -150,0 +193,0 @@ };

rules/no-process-exit.js

@@ -13,2 +13,6 @@ 'use strict';
 
+	// Only report if it's outside an worker thread context. See #328.
+	let requiredWorkerThreadsModule = false;
+	const reports = [];
+
 	return {
@@ -18,2 +22,17 @@ CallExpression: node => {
 
+			if (callee.type === 'Identifier' && callee.name === 'require') {
+				const args = node.arguments;
+
+				if (args.length === 0) {
+					return;
+				}
+
+				const [argument] = args;
+
+				if (argument.type === 'Literal' && argument.value === 'worker_threads') {
+					requiredWorkerThreadsModule = true;
+					return;
+				}
+			}
+
 			if (callee.type === 'MemberExpression' && callee.object.name === 'process') {
@@ -26,6 +45,9 @@ if (callee.property.name === 'on' || callee.property.name === 'once') {
 				if (callee.property.name === 'exit' && !processEventHandler) {
-					context.report({
-						node,
-						message: 'Only use `process.exit()` in CLI apps. Throw an error instead.'
-					});
+					reports.push(
+						() =>
+							context.report({
+								node,
+								message: 'Only use `process.exit()` in CLI apps. Throw an error instead.'
+							})
+					);
 				}
@@ -38,2 +60,18 @@ }
 			}
+		},
+
+		ImportDeclaration: node => {
+			const {source} = node;
+
+			if (source.type === 'Literal' && source.value === 'worker_threads') {
+				requiredWorkerThreadsModule = true;
+			}
+		},
+
+		'Program:exit': () => {
+			if (!requiredWorkerThreadsModule) {
+				for (const report of reports) {
+					report();
+				}
+			}
 		}
@@ -40,0 +78,0 @@ };

rules/prevent-abbreviations.js

@@ -9,2 +9,3 @@ 'use strict';
 const avoidCapture = require('./utils/avoid-capture');
+const cartesianProductSamples = require('./utils/cartesian-product-samples');
 
@@ -237,3 +238,8 @@ const isUpperCase = string => string === string.toUpperCase();
 
-const getWordReplacements = (word, replacements) => {
+const getWordReplacements = (word, {replacements, whitelist}) => {
+	// Skip constants and whitelist
+	if (isUpperCase(word) || whitelist.get(word)) {
+		return [];
+	}
+
 	const replacement = replacements.get(lowerFirst(word)) ||
@@ -253,23 +259,5 @@ replacements.get(word) ||
 
-const getReplacementsFromCombinations = (combinations, length = Infinity) => {
-	const total = combinations.reduce((total, {length}) => total * length, 1);
+const getNameReplacements = (name, options, limit = 3) => {
+	const {whitelist} = options;
 
-	const samples = Array.from({length: Math.min(total, length)}, (_, sampleIndex) => {
-		let indexLeft = sampleIndex;
-		return combinations.reduceRight((words, replacements) => {
-			const {length} = replacements;
-			const replacementIndex = indexLeft % length;
-			indexLeft -= replacementIndex;
-			indexLeft /= length;
-			return [replacements[replacementIndex], ...words];
-		}, []).join('');
-	});
-
-	return {
-		total,
-		samples
-	};
-};
-
-const getNameReplacements = (name, {replacements, whitelist}, limit = 3) => {
 	// Skip constants and whitelist
@@ -281,3 +269,3 @@ if (isUpperCase(name) || whitelist.get(name)) {
 	// Find exact replacements
-	const exactReplacements = getWordReplacements(name, replacements);
+	const exactReplacements = getWordReplacements(name, options);
 
@@ -296,3 +284,3 @@ if (exactReplacements.length > 0) {
 	const combinations = words.map(word => {
-		const wordReplacements = getWordReplacements(word, replacements);
+		const wordReplacements = getWordReplacements(word, options);
 
@@ -312,3 +300,11 @@ if (wordReplacements.length > 0) {
 
-	return getReplacementsFromCombinations(combinations, limit);
+	const {
+		total,
+		samples
+	} = cartesianProductSamples(combinations, limit);
+
+	return {
+		total,
+		samples: samples.map(words => words.join(''))
+	};
 };
@@ -315,0 +311,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

156870

increased by2.62%

Number of package files

56

increased by3.7%

Lines of code

4967

increased by2.6%

Number of lines in readme file

166

increased by1.84%

Worsened metrics

Dependency count

17

increased by6.25%

Dependency changes

• + Addedeslint-template-visitor@^1.0.0

• + Addedread-pkg-up@^6.0.0

• + Addedacorn@7.4.1(transitive)

• + Addedansi-escapes@4.3.2(transitive)

• + Addedansi-regex@4.1.15.0.1(transitive)

• + Addedargparse@1.0.10(transitive)

• + Addedastral-regex@1.0.0(transitive)

• + Addedchardet@0.7.0(transitive)

• + Addedcli-cursor@3.1.0(transitive)

• + Addedcli-width@3.0.0(transitive)

• + Addedcross-spawn@6.0.5(transitive)

• + Addeddoctrine@3.0.0(transitive)

• + Addedemoji-regex@7.0.38.0.0(transitive)

• + Addedeslint@6.8.0(transitive)

• + Addedeslint-scope@5.1.1(transitive)

• + Addedeslint-template-visitor@1.1.0(transitive)

• + Addedeslint-utils@1.4.3(transitive)

• + Addedeslint-visitor-keys@1.3.0(transitive)

• + Addedespree@6.2.1(transitive)

• + Addedesprima@4.0.1(transitive)

• + Addedestraverse@4.3.0(transitive)

• + Addedexternal-editor@3.1.0(transitive)

• + Addedfigures@3.2.0(transitive)

• + Addedfile-entry-cache@5.0.1(transitive)

• + Addedfind-up@4.1.0(transitive)

• + Addedflat-cache@2.0.1(transitive)

• + Addedflatted@2.0.2(transitive)

• + Addedfs.realpath@1.0.0(transitive)

• + Addedfunctional-red-black-tree@1.0.1(transitive)

• + Addedglob@7.2.3(transitive)

• + Addedglob-parent@5.1.2(transitive)

• + Addedglobals@12.4.0(transitive)

• + Addediconv-lite@0.4.24(transitive)

• + Addedignore@4.0.6(transitive)

• + Addedinflight@1.0.6(transitive)

• + Addedinherits@2.0.4(transitive)

• + Addedinquirer@7.3.3(transitive)

• + Addedis-fullwidth-code-point@2.0.03.0.0(transitive)

• + Addedjs-yaml@3.14.1(transitive)

• + Addedlevn@0.3.0(transitive)

• + Addedlocate-path@5.0.0(transitive)

• + Addedlodash@4.17.21(transitive)

• + Addedmimic-fn@2.1.0(transitive)

• + Addedminimist@1.2.8(transitive)

• + Addedmkdirp@0.5.6(transitive)

• + Addedmultimap@1.1.0(transitive)

• + Addedmute-stream@0.0.8(transitive)

• + Addednice-try@1.0.5(transitive)

• + Addedonce@1.4.0(transitive)

• + Addedonetime@5.1.2(transitive)

• + Addedoptionator@0.8.3(transitive)

• + Addedos-tmpdir@1.0.2(transitive)

• + Addedp-limit@2.3.0(transitive)

• + Addedp-locate@4.1.0(transitive)

• + Addedp-try@2.2.0(transitive)

• + Addedpath-is-absolute@1.0.1(transitive)

• + Addedpath-key@2.0.1(transitive)

• + Addedprelude-ls@1.1.2(transitive)

• + Addedprogress@2.0.3(transitive)

• + Addedread-pkg-up@6.0.0(transitive)

• + Addedregexpp@2.0.1(transitive)

• + Addedrestore-cursor@3.1.0(transitive)

• + Addedrimraf@2.6.3(transitive)

• + Addedrun-async@2.4.1(transitive)

• + Addedrxjs@6.6.7(transitive)

• + Addedsafer-buffer@2.1.2(transitive)

• + Addedshebang-command@1.2.0(transitive)

• + Addedshebang-regex@1.0.0(transitive)

• + Addedsignal-exit@3.0.7(transitive)

• + Addedslice-ansi@2.1.0(transitive)

• + Addedsprintf-js@1.0.3(transitive)

• + Addedstring-width@3.1.04.2.3(transitive)

• + Addedstrip-ansi@5.2.06.0.1(transitive)

• + Addedtable@5.4.6(transitive)

• + Addedthrough@2.3.8(transitive)

• + Addedtmp@0.0.33(transitive)

• + Addedtslib@1.14.1(transitive)

• + Addedtype-check@0.3.2(transitive)

• + Addedtype-fest@0.21.30.5.20.8.1(transitive)

• + Addedv8-compile-cache@2.4.0(transitive)

• + Addedwhich@1.3.1(transitive)

• + Addedwrappy@1.0.2(transitive)

• + Addedwrite@1.0.3(transitive)

• - Removedread-pkg@^5.2.0