eslint-plugin-veeva v2.0.2

eslint-plugin-veeva

Set of rules ensuring compatibility of your code with Veeva environment.

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-veeva:

npm install eslint-plugin-veeva --save-dev

Usage

Add veeva to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
  "plugins": ["veeva"]
}

Then configure the rules you want to use under the rules section.

{
  "rules": {
    "veeva/rule-name": 2
  }
}

Or

Extend from already existing config

{
  "extends": ["plugin:veeva/astro"]
}

Rules

💼 Configurations enabled in.

Name	Description	💼
astro-no-client-directive	disallow use of client: directive to ensure veeva compatibility
no-empty-files	disallow empty files

Contributing to eslint-plugin-veeva

Thank you for considering contributing to this ESLint plugin! Your contributions are valuable in helping maintain compatibility with the Veeva environment.

Areas worth contributing

1. Add CI/CD
2. Add Testing
3. Improve project structure and guidelines
4. Add new rules

Prerequisites

Before you can contribute, make sure you have the following prerequisites installed:

• Node.js (and npm) - The plugin is built using Node.js, so you need it to run development scripts.

Cloning the Repository

To get started, you'll need to clone the repository to your local machine:

git clone https://github.com/daniel-beranek/eslint-plugin-veeva.git

Setting Up the Development Environment

Navigate to the cloned directory:

cd eslint-plugin-veeva

Install the project dependencies:

npm install

Making changes

Create a new branch for your changes. It's a good practice to create a branch that describes the feature or fix you're working on:

git checkout -b feature-name

Linting

To ensure your code adheres to the ESLint rules, you can run linting with:

npm run lint

Pushing Changes

Push your branch to the remote repository:

git push origin feature-name

Opening a Pull Request

1. Visit the GitHub repository for eslint-plugin-veeva: https://github.com/daniel-beranek/eslint-plugin-veeva

2. Click on the "Pull Requests" tab and then the "New Pull Request" button.

3. Choose your branch (e.g., feature-name) as the base branch.

4. Write a clear title and description for your pull request. Be sure to describe what the change does and why it's needed.

5. Submit the pull request.

Review and Collaboration

Your pull request will be reviewed by the maintainers and other contributors. Be prepared to address any feedback or make necessary changes.

Thank you for your contribution!

Please note that it's important to follow the project's specific contribution guidelines and coding standards if they exist, which can be found in the project's repository or documentation.