Skip to content

Commit

Permalink
add redme doku and clean up the naming convention rules
Browse files Browse the repository at this point in the history
  • Loading branch information
Miguel7373 committed Dec 19, 2024
1 parent de560e7 commit 226b291
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 13 deletions.
3 changes: 3 additions & 0 deletions frontend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ Build:
We use the **prettier** code formatter for the frontend code:
https://www.npmjs.com/package/prettier

If you get a does not match pattern error, it is likely because of the custom words for the OKR tool
here is a regex101 project that showcases how the regex works:
https://regex101.com/r/VUyAt6/1
## Test Coverage

For generating the coverage of our frontend specs (jest), you can use following command:
Expand Down
16 changes: 3 additions & 13 deletions frontend/eslint.config.mjs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import tsEslint from "typescript-eslint";
import html from "@html-eslint/eslint-plugin";
import { createRegexForWords } from "./eslintHelper.mjs"

import * as constants from "node:constants";

export default tsEslint.config(
{
Expand All @@ -18,24 +18,14 @@ export default tsEslint.config(

selector: ["class", "interface"], format: ["PascalCase"]
}, {
// It has to many exceptions for me to check this usefully
//
// selector: "typeProperty", types: ["string"], modifiers: ["readonly"], format: ["UPPER_CASE"]
// },{
// selector: "classProperty", modifiers: ["readonly"], format: ["UPPER_CASE"]
// }, {
// selector: "variable", modifiers: ["global"], types: ["string"], format: ["UPPER_CASE"]
// }, {
// selector: "variable", modifiers: [], format: ["camelCase"]
// }, {
selector: "variable", modifiers: [], format: ["camelCase", "UPPER_CASE"]
}, {
selector: "enum", format: ["PascalCase"]
}, {
selector: "enumMember", format: ["UPPER_CASE"]
}, {
selector: ["method", "function"], format: ["camelCase"]
}, {
// selector: "property", format: ["camelCase"]
// }, {
selector: "typeParameter", format: ["PascalCase"]
}
],
Expand Down

0 comments on commit 226b291

Please sign in to comment.