Initial commit

Author: vkrol

.eslintignore

@@ -0,0 +1 @@
+!.eslintrc.js

.eslintrc.js

@@ -0,0 +1,18 @@
+module.exports = {
+	parserOptions: {
+		ecmaVersion: 2018,
+	},
+	env: {
+		commonjs: true,
+		es6: true,
+		node: true,
+	},
+	extends: ["eslint:recommended", "plugin:eslint-plugin/recommended", "plugin:prettier/recommended"],
+	plugins: ["eslint-plugin"],
+	rules: {
+		"eslint-plugin/meta-property-ordering": "error",
+		"eslint-plugin/prefer-placeholders": "error",
+		"eslint-plugin/test-case-property-ordering": "error",
+		"eslint-plugin/test-case-shorthand-strings": "error",
+	},
+};

.gitattributes

@@ -0,0 +1 @@
+* text=auto

.gitignore

@@ -0,0 +1,88 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+
+# next.js build output
+.next
+
+# nuxt.js build output
+.nuxt
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/

.yarnrc

@@ -0,0 +1 @@
+save-exact true

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Appulate
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,3 @@
+# eslint-plugin-appulate
+
+Appulate’s ESLint rules.

lib/index.js

@@ -0,0 +1,3 @@
+module.exports.rules = {
+	"no-undef-blacklist": require("./rules/no-undef-blacklist.js.js"),
+};

lib/rules/__tests__/no-undef-blacklist.test.js

@@ -0,0 +1,32 @@
+const rule = require("../no-undef-blacklist");
+const { RuleTester } = require("eslint/lib/rule-tester");
+
+const options = ["foo", "bar"];
+const parserOptions = {
+	ecmaVersion: 2018,
+	sourceType: "module",
+};
+const ruleTester = new RuleTester();
+
+ruleTester.run("no-undef-blacklist", rule, {
+	valid: [
+		{ code: "import foo from 'foo'; foo();", options, parserOptions },
+		{ code: "import bar from 'bar'; bar();", options, parserOptions },
+		{ code: "import xyz from 'xyz'; xyz();", options, parserOptions },
+		{ code: "xyz();", options, parserOptions },
+	],
+	invalid: [
+		{
+			code: "foo();",
+			options,
+			parserOptions,
+			errors: [{ messageId: "undef", data: { name: "foo" }, type: "Identifier" }],
+		},
+		{
+			code: "bar();",
+			options,
+			parserOptions,
+			errors: [{ messageId: "undef", data: { name: "bar" }, type: "Identifier" }],
+		},
+	],
+});

lib/rules/no-undef-blacklist.js

@@ -0,0 +1,59 @@
+/**
+ * @fileoverview Rule to flag references to undeclared variables.
+ * @copyright 2019 Appulate
+ * @copyright JS Foundation and other contributors, https://js.foundation
+ */
+
+/**
+ * This rule is a fork of https://eslint.org/docs/rules/no-undef that adds an ability to specify a blacklist of identifiers.
+ * Ideally, we wouldn't need this rule, because we could rely on TypeScript. But some typings, such as @types/jquery
+ * or @types/knockout declare global variables (i.e. $) and TypeScript does not throw any errors when such a global
+ * variable is used in the module without its import. The original no-undef rule works incorrectly in TypeScript files
+ * because of the error https://github.com/typescript-eslint/typescript-eslint/issues/342, so we had to write our own
+ * rule that accepts the list of certain problematic identifiers.
+ */
+
+"use strict";
+
+module.exports = {
+	meta: {
+		type: "problem",
+		docs: {
+			description: "disallow the use of undeclared variables unless mentioned in `/*global */` comments",
+			category: "Variables",
+		},
+		schema: {
+			type: "array",
+			items: {
+				type: "string",
+			},
+			uniqueItems: true,
+			minItems: 1,
+		},
+		messages: {
+			undef: "'{{name}}' is not defined.",
+		},
+	},
+
+	create(context) {
+		const blacklist = context.options;
+
+		return {
+			"Program:exit"() {
+				const globalScope = context.getScope();
+
+				globalScope.through.forEach(ref => {
+					const { identifier } = ref;
+
+					if (blacklist.includes(identifier.name)) {
+						context.report({
+							node: identifier,
+							messageId: "undef",
+							data: identifier,
+						});
+					}
+				});
+			},
+		};
+	},
+};

package.json

@@ -0,0 +1,38 @@
+{
+	"name": "@appulate/eslint-plugin",
+	"version": "0.1.0",
+	"description": "Appulate's ESLint rules",
+	"repository": "appulate/eslint-plugin-appulate",
+	"main": "lib/index.js",
+	"license": "MIT",
+	"files": [
+		"lib",
+		"!__tests__"
+	],
+	"keywords": [
+		"eslint",
+		"eslintplugin",
+		"eslint-plugin",
+		"linter",
+		"lint",
+		"appulate"
+	],
+	"scripts": {
+		"lint": "eslint .",
+		"test": "jest"
+	},
+	"engines": {
+		"node": ">=10"
+	},
+	"peerDependencies": {
+		"eslint": ">=5"
+	},
+	"devDependencies": {
+		"eslint": "6.1.0",
+		"eslint-config-prettier": "6.0.0",
+		"eslint-plugin-eslint-plugin": "2.1.0",
+		"eslint-plugin-prettier": "3.1.0",
+		"jest": "24.9.0",
+		"prettier": "1.18.2"
+	}
+}

prettier.config.js

@@ -0,0 +1,10 @@
+module.exports = {
+	printWidth: 120,
+	tabWidth: 4,
+	useTabs: true,
+	semi: true,
+	singleQuote: false,
+	trailingComma: "all",
+	bracketSpacing: true,
+	jsxBracketSameLine: false,
+};