-
Notifications
You must be signed in to change notification settings - Fork 135
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into elements-chain-string
- Loading branch information
Showing
98 changed files
with
5,764 additions
and
3,980 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -77,5 +77,5 @@ jobs: | |
|
|
||
| - run: | | ||
| yarn prettier --check | ||
| yarn eslint | ||
| yarn lint | ||
| yarn tsc -b | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,7 +17,7 @@ jobs: | |
| runs-on: ubuntu-latest | ||
|
|
||
| strategy: | ||
| matrix: | ||
| matrix: | ||
| browserstack: | ||
| - chrome | ||
| - ie | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # PostHog JS Custom ESLint rules | ||
|
|
||
| This package contains custom ESLint rules for PostHog's JS codebase. | ||
|
|
||
| For example, we have a number of functions that check types like `_isNull` or `isBoolean`. | ||
| In most projects these don't help very much but since posthog-js is bundled and included in many different projects, | ||
| we want to ensure the bundle size is as small as possible. Moving to these functions reduced bundle by 1%, so we | ||
| use a set of custom linters to ensure we don't accidentally add new code that does not use these helpers. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| const noDirectNullCheck = require('./no-direct-null-check') | ||
| const noDirectUndefinedCheck = require('./no-direct-undefined-check') | ||
| const noDirectArrayCheck = require('./no-direct-array-check') | ||
| const noDirectIsFunctionCheck = require('./no-direct-function-check') | ||
| const noDirectObjectCheck = require('./no-direct-object-check') | ||
| const noDirectStringCheck = require('./no-direct-string-check') | ||
| const noDirectDateCheck = require('./no-direct-date-check') | ||
| const noDirectNumberCheck = require('./no-direct-number-check') | ||
| const noDirectBooleanCheck = require('./no-direct-boolean-check') | ||
|
|
||
| const { RuleTester } = require('eslint') | ||
|
|
||
| const ruleTester = new RuleTester() | ||
|
|
||
| ruleTester.run('no-direct-null-check', noDirectNullCheck, { | ||
| valid: [{ code: `_isNull(x)` }], | ||
| invalid: [{ code: `x === null`, errors: [{ message: 'Use _isNull() instead of direct null checks.' }] }], | ||
| }) | ||
|
|
||
| ruleTester.run('no-direct-undefined-check', noDirectUndefinedCheck, { | ||
| valid: [{ code: `_isUndefined(x)` }], | ||
| invalid: [ | ||
| { | ||
| code: `typeof x === undefined`, | ||
| errors: [{ message: 'Use _isUndefined() instead of direct undefined checks.' }], | ||
| }, | ||
| ], | ||
| }) | ||
|
|
||
| ruleTester.run('no-direct-array-check', noDirectArrayCheck, { | ||
| valid: [{ code: `_isArray(x)` }], | ||
| invalid: [ | ||
| { | ||
| code: `Array.isArray(x)`, | ||
| errors: [{ message: 'Use _isArray() instead of direct array checks.' }], | ||
| }, | ||
| ], | ||
| }) | ||
|
|
||
| ruleTester.run('no-direct-is-function-check', noDirectIsFunctionCheck, { | ||
| valid: [{ code: `_isFunction(x)` }], | ||
| invalid: [ | ||
| { | ||
| code: `/^\\s*\\bfunction\\b/.test(x)`, | ||
| errors: [{ message: 'Do not use regex to check for functions. Use _isFunction instead.' }], | ||
| }, | ||
| { | ||
| code: `x instanceof Function`, | ||
| errors: [{ message: "Do not use 'instanceof Function' to check for functions. Use _isFunction instead." }], | ||
| }, | ||
| { | ||
| code: `typeof x === "function"`, | ||
| errors: [ | ||
| { message: 'Do not use \'typeof x === "function"\' to check for functions. Use _isFunction instead.' }, | ||
| ], | ||
| }, | ||
| ], | ||
| }) | ||
|
|
||
| ruleTester.run('no-direct-object-check', noDirectObjectCheck, { | ||
| valid: [{ code: `_isObject(x)` }], | ||
| invalid: [ | ||
| { | ||
| code: `obj === Object(obj)`, | ||
| errors: [{ message: "Do not use 'obj === Object(obj)'. Use _isObject instead." }], | ||
| }, | ||
| ], | ||
| }) | ||
|
|
||
| ruleTester.run('no-direct-string-check', noDirectStringCheck, { | ||
| valid: [{ code: `_isString(x)` }], | ||
| invalid: [ | ||
| { | ||
| code: `toString.call(x) == '[object String]'`, | ||
| errors: [{ message: 'Use _isString instead of direct string checks.' }], | ||
| }, | ||
| { | ||
| code: `x instanceof String`, | ||
| errors: [{ message: 'Use _isString instead of direct string checks.' }], | ||
| }, | ||
| ], | ||
| }) | ||
|
|
||
| ruleTester.run('no-direct-date-check', noDirectDateCheck, { | ||
| valid: [{ code: `_isDate(x)` }], | ||
| invalid: [ | ||
| { | ||
| code: `toString.call(obj) == '[object Date]'`, | ||
| errors: [{ message: 'Use _isDate instead of direct date checks.' }], | ||
| }, | ||
| { | ||
| code: `x instanceof Date`, | ||
| errors: [{ message: 'Use _isDate instead of direct date checks.' }], | ||
| }, | ||
| ], | ||
| }) | ||
|
|
||
| ruleTester.run('no-direct-number-check', noDirectNumberCheck, { | ||
| valid: [{ code: `_isNumber(x)` }], | ||
| invalid: [ | ||
| { | ||
| code: `toString.call(obj) == '[object Number]'`, | ||
| errors: [{ message: 'Use _isNumber instead of direct number checks.' }], | ||
| }, | ||
| { | ||
| code: `typeof x === 'number'`, | ||
| errors: [{ message: 'Use _isNumber instead of direct number checks.' }], | ||
| }, | ||
| ], | ||
| }) | ||
|
|
||
| ruleTester.run('no-direct-boolean-check', noDirectBooleanCheck, { | ||
| valid: [{ code: `_isBoolean(x)` }], | ||
| invalid: [ | ||
| { | ||
| code: `toString.call(obj) == '[object Boolean]'`, | ||
| errors: [{ message: 'Use _isBoolean instead of direct boolean checks.' }], | ||
| }, | ||
| { | ||
| code: `typeof x === 'boolean'`, | ||
| errors: [{ message: 'Use _isBoolean instead of direct boolean checks.' }], | ||
| }, | ||
| ], | ||
| }) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| const { readdirSync } = require('fs') | ||
| const { basename } = require('path') | ||
|
|
||
| const projectName = 'posthog-js' | ||
| const ruleFiles = readdirSync('eslint-rules').filter( | ||
| (file) => file.endsWith('.js') && file !== 'index.js' && !file.endsWith('test.js') | ||
| ) | ||
| const configs = { | ||
| all: { | ||
| plugins: [projectName], | ||
| rules: Object.fromEntries(ruleFiles.map((file) => [`${projectName}/${basename(file, '.js')}`, 'error'])), | ||
| }, | ||
| } | ||
|
|
||
| const rules = Object.fromEntries(ruleFiles.map((file) => [basename(file, '.js'), require('./' + file)])) | ||
|
|
||
| module.exports = { configs, rules } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| module.exports = { | ||
| create(context) { | ||
| return { | ||
| MemberExpression: function (node) { | ||
| // Check if the object is 'Array' and the property is 'isArray' | ||
| if ( | ||
| node.object.type === 'Identifier' && | ||
| node.object.name === 'Array' && | ||
| node.property.type === 'Identifier' && | ||
| node.property.name === 'isArray' | ||
| ) { | ||
| context.report({ | ||
| node, | ||
| message: 'Use _isArray() instead of direct array checks.', | ||
| }) | ||
| } | ||
| }, | ||
| } | ||
| }, | ||
| } |
Oops, something went wrong.