@mogrady-professional/linting-ts v1.0.3

Linting-ts

Description

Linting-ts is a TypeScript project that focuses on providing linting configurations and rules for maintaining code quality and consistency in TypeScript projects.

Features

• Pre-configured linting rules for TypeScript projects
• Customizable linting configurations to suit project-specific requirements
• Integration with popular code editors and build tools for seamless linting experience
• Continuous integration and automated linting checks for ensuring code quality in development workflows

Installation

To use linting-ts in your TypeScript project, follow these steps:

1. Install the package using npm:

npm install @mogrady-professional/linting-ts --save-dev

2. Configure the linting rules in your project's tsconfig.json file:

{
  "extends": "linting-ts"
}

2. Or Create a eslint.config.js file in the root of your project and add the following code:

import tseslint from "@mogrady-professional/linting-ts";

/**
 * Linting Configuration – Default ESLint Configuration for TypeScript projects.
 * @remarks This configuration includes custom rules for your project.
 *
 * @returns {Object[]} ESLint Configuration array
 */
const eslintRules = [
  ...tseslint,
  /* Your Project – Custom ESLint Configuration */
  {
    name: "Custom Configuration",
    rules: {},
    linterOptions: {
      noInlineConfig: false /** Allow inline configuration @see {@link https://eslint.org/docs/developer-guide/nodejs-api#linter}*/,
    },
  },
];

export default eslintRules;

3. Run the linting command to check your project for linting errors:

npm run lint

Contributing

Contributions are welcome! If you would like to contribute to linting-ts, please follow these guidelines:

1. Fork the repository and clone it to your local machine.
2. Create a new branch for your feature or bug fix.
3. Make your changes and ensure that the tests pass.
4. Commit your changes and push them to your forked repository.
5. Open a pull request with a clear description of your changes.

License

This project is licensed under the MIT License. See the LICENSE file for more information.