Installations

npm install @linzjs/style

Pull Requests

Open

5

Total

1,055

Closed

766

Merged

284

Issues

Open

0

Total

5

Closed

5

Releases

24

v5.4.0

Published on 23 Jun 2024

v5.3.0

Published on 22 May 2024

v5.2.0

Published on 09 Jan 2024

v5.1.0

Published on 13 Nov 2023

v5.0.0

Published on 10 Sept 2023

v4.2.0

Published on 21 Jun 2023

View all 24 releases

Developer

linz

Developer Guide

BETA

Module System

ESM

Min. Node Version

Typescript Support

No

Node Version

20.14.0

NPM Version

10.7.0 Statistics

4 Stars

336 Commits

2 Forks

5 Watching

7 Branches

122 Contributors

Updated on 23 Jun 2024

Languages

JavaScript (63.26%)

TypeScript (36.74%)

Total Downloads

Cumulative downloads

Total Downloads

1,186,769

Last day

3.1%

1,798

Compared to previous day

Last week

0.7%

9,303

Compared to previous week

Last month

-4.5%

42,631

Compared to previous month

Last year

14.2%

393,730

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

10

@typescript-eslint/eslint-plugin @typescript-eslint/parser eslint eslint-config-prettier eslint-plugin-prettier eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-simple-import-sort prettier typescript

Dev Dependencies

2

@types/node @types/react

Versions

@linzjs/style

NPM configuration for base typescript projects

Includes:

Prettier
Eslint
Typescript

And configuration for saneish defaults, which can be extended

Most of these are the raw defaults/recommended settings from typescript, eslint and prettier.

1export class FooBar {
2  get foo(): number {
3    return 1;
4  }
5
6  async bar(): Promise<string> {
7    return 'bar';
8  }
9
10  /**
11   * @param foo foo to bar
12   */
13  fooBar(foo = 'foo'): string {
14    return `${foo}bar`;
15  }
16}

IDE Usage

Usage VS Code

Install eslint using the extensions menu
Add the following to your settings.json

1"editor.codeActionsOnSave": {
2    "source.fixAll.eslint": true
3},
4"eslint.validate": ["javascript"],

Usage with IntelliJ

IntelliJ has ESLint support by default,

Open the settings in Languages & Frameworks > JavaScript > Code Quality Tools > ESLint
Check Automatic ESLint Configuration

Project Usage

Install LINZ Style

1npm install @linzjs/style

Applying eslint config There are two ways to apply the config

Either create the base configuration files

1# If on windows run `node ./node_modules/@linzjs/style/build/src/install.js`
2# - tsconfig.json
3# - .eslintrc.cjs
4# - .prettierrc.cjs
5npx linz-style-install

Or extend your existing eslintrc.js config

Example extending the .eslintrc.js file in your project

1module.exports = {
2  extends: ["./node_modules/@linzjs/style/.eslintrc.cjs"],
3
4  overrides: [
5    {
6      /** Overrides for typescript */
7      files: ["**/*.ts", "**/*.tsx"],      
8      rules: {
9        "@typescript-eslint/super-crazy-hook-rule": "error",
10      },
11    },
12  ]
13}

Apply the formatting/linting to all source code

npx eslint .

Migration from 3.x to 4.x

See Migration Docs

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

9

License

Determines if the project has defined a license.

8

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

7

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

SAST

Determines if the project uses static code analysis.

Score

4.3

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More