From 01f87025e11c16bd94e4bb5ed8bb4a29bbec7080 Mon Sep 17 00:00:00 2001 From: Galen Charlton Date: Fri, 9 Sep 2022 10:43:59 -0400 Subject: [PATCH] LP#1959048: add release notes Signed-off-by: Galen Charlton Signed-off-by: Jane Sandberg --- docs/RELEASE_NOTES_NEXT/Architecture/eslint.adoc | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 docs/RELEASE_NOTES_NEXT/Architecture/eslint.adoc diff --git a/docs/RELEASE_NOTES_NEXT/Architecture/eslint.adoc b/docs/RELEASE_NOTES_NEXT/Architecture/eslint.adoc new file mode 100644 index 0000000000..c074b92ce8 --- /dev/null +++ b/docs/RELEASE_NOTES_NEXT/Architecture/eslint.adoc @@ -0,0 +1,21 @@ +== (Developer-focused) Use ESLint for eg2 == + +The `eg2` Angular application now uses ESLint rather than TSLint for +source code linting. This is motivated by the deprecation of TSLint +by the Angular CLI, but ESLint also offer some improvements. + +In particular, ESLint checks the HTML templates in addition to the +TypeScript code. For example, it will catch uses of `==` in the +templates when `===` is preferred. + +The primary ESLint rules applied to the project are configured in +`Open-ILS/src/eg2/.eslintrc.json`. To override them for specific +directories, `.eslintrc` files can be used. An example of this +is `Open-ILS/src/eg2/src/app/share/.eslintrc`, which turns off +the `angular-eslint/no-output-on-prefix` check that discourages +using `onFoo` as the name of `@Output()` properties. This rule +is now enforced in most of `eg2`, but it was decided not to immediately +mandate for shared components. + +The command to run the lint checks remains the same: from +`Open-ILS/src/eg2/`, run `ng lint`. -- 2.11.0