Skip to content

Commit

Permalink
setup update
Browse files Browse the repository at this point in the history
  • Loading branch information
@haifeng-li-at-salesforce
haifeng-li-at-salesforce committed May 1, 2024
1 parent d54b370 commit d439878
Show file tree
Hide file tree
Showing 10 changed files with 299 additions and 1,468 deletions.
28 changes: 28 additions & 0 deletions .eslintrc
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"root": true,
"extends": [
"eslint:recommended",
"plugin:node/recommended"
],
"overrides": [
{
"files": ["lib/rules/*.{js,ts}"],
"extends": ["plugin:eslint-plugin/rules-recommended"],
"rules": {
"eslint-plugin/prefer-message-ids": "off" // Messages come straight from Komaci.
}
}
],
"env": {
"es6": true,
"jest": true,
"node": true
},
"parserOptions": {
"ecmaVersion": 6
},
"rules": {
"strict": ["error", "global"]
},
"ignorePatterns": ["test/**/test.js"]
}
18 changes: 18 additions & 0 deletions .github/workflows/lint.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: lint
run-name: Installs project and runs linting
on: [ push, pull_request ]
jobs:
lint:
runs-on: ubuntu-latest
strategy:
matrix:
node: [ 18, 20 ]
name: Linting on Ubuntu with Node ${{ matrix.node }}
steps:
- uses: actions/checkout@v3
- uses: actions/setup-node@v3
with:
node-version: ${{ matrix.node }}
cache: 'npm'
- run: yarn install
- run: yarn lint
28 changes: 27 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
@@ -1 +1,27 @@
# @salesforce/eslint-plugin-lwc-mobile
# @salesforce/eslint-plugin-lwc-mobile

## Installation

To add this plugin to your package/project, install it with your favorite Node.js package manager.

### yarn

```sh
$ yarn add --dev @salesforce/eslint-plugin-lwc-mobile
```

### npm

```sh
$ npm install --save-dev @salesforce/eslint-plugin-lwc-mobile
```

## Configuration

Here's an example snippet of a `.eslintrc.json` configuration file, that will configure the `eslint-plugin-lwc-graph-analyzer` plugin. Extending the `plugin:@salesforce/lwc-mobile/recommended` ESLint configuration will enable static analysis on all `.js` files used in your Lightning web components.

```json
{
"extends": ["eslint:recommended", "plugin:@salesforce/lwc-mobile/recommended"]
}
```
224 changes: 30 additions & 194 deletions jest.config.js
View file
Original file line number Diff line number Diff line change
@@ -1,199 +1,35 @@
/**
* For a detailed explanation regarding each configuration property, visit:
* https://jestjs.io/docs/configuration
/*
* Copyright (c) 2022, salesforce.com, inc.
* All rights reserved.
* SPDX-License-Identifier: MIT
* For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/MIT
*/

/** @type {import('jest').Config} */
const config = {
// All imported modules in your tests should be mocked automatically
// automock: false,

// Stop running tests after `n` failures
// bail: 0,

// The directory where Jest should store its cached dependency information
// cacheDirectory: "/private/var/folders/gg/lr2pvw8x3wgbrc5sbptr0sqc0000gq/T/jest_dz",

// Automatically clear mock calls, instances, contexts and results before every test
clearMocks: true,

// Indicates whether the coverage information should be collected while executing the test
'use strict';

module.exports = {
displayName: 'Unit Tests',
setupFilesAfterEnv: ['jest-extended', 'jest-chain'],
testMatch: [
'<rootDir>/test/plugin.js',
'<rootDir>/test/lib/rules/**/*.js',
'!**/test/lib/rules/shared.js'
],
moduleFileExtensions: ['js', 'json'],
testResultsProcessor: 'jest-sonar-reporter',
testPathIgnorePatterns: ['/node_modules/', '<rootDir>/lib/'],
moduleDirectories: ['node_modules'],
collectCoverage: true,

// An array of glob patterns indicating a set of files for which coverage information should be collected
// collectCoverageFrom: undefined,

// The directory where Jest should output its coverage files
collectCoverageFrom: ['lib/**/*.js'],
coverageDirectory: 'reports/coverage',

// An array of regexp pattern strings used to skip coverage collection
// coveragePathIgnorePatterns: [
// "/node_modules/"
// ],

// Indicates which provider should be used to instrument code for coverage
// coverageProvider: "babel",

// A list of reporter names that Jest uses when writing coverage reports
// coverageReporters: [
// "json",
// "text",
// "lcov",
// "clover"
// ],

// An object that configures minimum threshold enforcement for coverage results
// coverageThreshold: undefined,

// A path to a custom dependency extractor
// dependencyExtractor: undefined,

// Make calling deprecated APIs throw helpful error messages
// errorOnDeprecated: false,

// The default configuration for fake timers
// fakeTimers: {
// "enableGlobally": false
// },

// Force coverage collection from ignored files using an array of glob patterns
// forceCoverageMatch: [],

// A path to a module which exports an async function that is triggered once before all test suites
// globalSetup: undefined,

// A path to a module which exports an async function that is triggered once after all test suites
// globalTeardown: undefined,

// A set of global variables that need to be available in all test environments
// globals: {},

// The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
// maxWorkers: "50%",

// An array of directory names to be searched recursively up from the requiring module's location
// moduleDirectories: [
// "node_modules"
// ],

// An array of file extensions your modules use
// moduleFileExtensions: [
// "js",
// "mjs",
// "cjs",
// "jsx",
// "ts",
// "tsx",
// "json",
// "node"
// ],

// A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
// moduleNameMapper: {},

// An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
// modulePathIgnorePatterns: [],

// Activates notifications for test results
// notify: false,

// An enum that specifies notification mode. Requires { notify: true }
// notifyMode: "failure-change",

// A preset that is used as a base for Jest's configuration
// preset: undefined,

// Run tests from one or more projects
// projects: undefined,

// Use this configuration option to add custom reporters to Jest
// reporters: undefined,

// Automatically reset mock state before every test
// resetMocks: false,

// Reset the module registry before running each individual test
// resetModules: false,

// A path to a custom resolver
// resolver: undefined,

// Automatically restore mock state and implementation before every test
// restoreMocks: false,

// The root directory that Jest should scan for tests and modules within
// rootDir: undefined,

// A list of paths to directories that Jest should use to search for files in
// roots: [
// "<rootDir>"
// ],

// Allows you to use a custom runner instead of Jest's default test runner
// runner: "jest-runner",

// The paths to modules that run some code to configure or set up the testing environment before each test
// setupFiles: [],

// A list of paths to modules that run some code to configure or set up the testing framework before each test
// setupFilesAfterEnv: [],

// The number of seconds after which a test is considered as slow and reported as such in the results.
// slowTestThreshold: 5,

// A list of paths to snapshot serializer modules Jest should use for snapshot testing
// snapshotSerializers: [],

// The test environment that will be used for testing
// testEnvironment: "jest-environment-node",

// Options that will be passed to the testEnvironment
// testEnvironmentOptions: {},

// Adds a location field to test results
// testLocationInResults: false,

// The glob patterns Jest uses to detect test files
testMatch: [
'<rootDir>/test/lib/rules/**/*.js',
'!**/test/lib/rules/**/test.js',
'!**/test/lib/rules/shared.js'
],

// An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
// testPathIgnorePatterns: [
// "/node_modules/"
// ],

// The regexp pattern or array of patterns that Jest uses to detect test files
// testRegex: [],

// This option allows the use of a custom results processor
testResultsProcessor: "jest-sonar-reporter",

// This option allows use of a custom test runner
// testRunner: "jest-circus/runner",

// A map from regular expressions to paths to transformers
// transform: undefined,

// An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
// transformIgnorePatterns: [
// "/node_modules/",
// "\\.pnp\\.[^\\/]+$"
// ],

// An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
// unmockedModulePathPatterns: undefined,

// Indicates whether each individual test should be reported during the run
// verbose: undefined,

// An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
// watchPathIgnorePatterns: [],

// Whether to use watchman for file crawling
// watchman: true,
reporters: [
'default',
[
'jest-junit',
{
suiteName: 'Unit Tests',
output: './reports/junit/jest-results.xml'
}
]
]
};

module.exports = config;
5 changes: 2 additions & 3 deletions lib/index.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,10 @@ const enforceFooBar = require('./rules/enforce-foo-bar');

module.exports = {
rules: {
'enforce-foo-bar': enforceFooBar,
'enforce-foo-bar': enforceFooBar
},
config: {
base,
recommended
}

}
};
30 changes: 15 additions & 15 deletions lib/rules/enforce-foo-bar.js
View file
Original file line number Diff line number Diff line change
@@ -1,35 +1,35 @@
/**
* @fileoverview Rule to enforce that `const foo` is assigned "bar".
* @author Ben Perlmutter
* @author Ben Perlmutter Sample rule from ESlint.org
*/

"use strict";
'use strict';

// The enforce-foo-bar rule definition
module.exports = {
meta: {
type: "problem",
type: 'problem',
docs: {
description: "Enforce that a variable named `foo` can only be assigned a value of 'bar'."
description:
"Enforce that a variable named `foo` can only be assigned a value of 'bar'."
},
fixable: "code",
fixable: 'code',
schema: []
},
create(context) {
return {

// Performs action in the function on every variable declarator
VariableDeclarator(node) {

// Check if a `const` variable declaration
if (node.parent.kind === "const") {

if (node.parent.kind === 'const') {
// Check if variable name is `foo`
if (node.id.type === "Identifier" && node.id.name === "foo") {

if (node.id.type === 'Identifier' && node.id.name === 'foo') {
// Check if value of variable is "bar"
if (node.init && node.init.type === "Literal" && node.init.value !== "bar") {

if (
node.init &&
node.init.type === 'Literal' &&
node.init.value !== 'bar'
) {
/*
* Report error to ESLint. Error message uses
* a message placeholder to include the incorrect value
Expand All @@ -39,7 +39,8 @@ module.exports = {
*/
context.report({
node,
message: 'Value other than "bar" assigned to `const foo`. Unexpected value: {{ notBar }}.',
message:
'Value other than "bar" assigned to `const foo`. Unexpected value: {{ notBar }}.',
data: {
notBar: node.init.value
},
Expand All @@ -54,4 +55,3 @@ module.exports = {
};
}
};

Loading

0 comments on commit d439878

Please sign in to comment.