├── .github
    ├── ISSUE_TEMPLATE
    │   ├── bug_report.md
    │   └── feature_request.md
    ├── pull_request_template.md
    ├── renovate.json
    └── workflows
    │   ├── integration-test.yml
    │   └── unittest.yml
├── .gitignore
├── .markdownlint.json
├── .markdownlintignore
├── .pre-commit-config.yaml
├── .pylintrc
├── .python-version
├── LICENSE
├── README.md
├── action.yml
├── images
    └── test-failure.png
├── src
    ├── checker.py
    └── ignition_lint.py
└── tests
    ├── cases
        ├── PascalCase
        │   ├── resource.json
        │   ├── thumbnail.png
        │   └── view.json
        ├── PreferredStyle
        │   ├── resource.json
        │   ├── thumbnail.png
        │   └── view.json
        ├── Title Case
        │   ├── resource.json
        │   ├── thumbnail.png
        │   └── view.json
        ├── UPPER_CASE
        │   ├── resource.json
        │   ├── thumbnail.png
        │   └── view.json
        ├── camelCase
        │   ├── resource.json
        │   ├── thumbnail.png
        │   └── view.json
        ├── inconsistentCase
        │   └── view.json
        ├── kebab-case
        │   ├── resource.json
        │   ├── thumbnail.png
        │   └── view.json
        └── snake_case
        │   ├── resource.json
        │   ├── thumbnail.png
        │   └── view.json
    ├── test_checker.py
    └── test_ignition_lint.py


/.github/ISSUE_TEMPLATE/bug_report.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | name: Bug report
 3 | about: Create a report to help us improve
 4 | title: "[BUG]"
 5 | labels: bug
 6 | assignees: ''
 7 | 
 8 | ---
 9 | 
10 | **Describe the bug**
11 | A clear and concise description of what the bug is.
12 | 
13 | **To Reproduce**
14 | Steps to reproduce the behavior:
15 | 
16 | 1. Go to '...'
17 | 2. Click on '....'
18 | 3. Scroll down to '....'
19 | 4. See error
20 | 
21 | **Expected behavior**
22 | A clear and concise description of what you expected to happen.
23 | 
24 | **Screenshots**
25 | If applicable, add screenshots to help explain your problem.
26 | 
27 | **Desktop (please complete the following information):**
28 | 
29 | - OS: [e.g. MacOS]
30 | - Browser [e.g. chrome, safari]
31 | - Version [e.g. 8.1.22]
32 | 
33 | **Smartphone (please complete the following information):**
34 | 
35 | - Device: [e.g. iPhone6]
36 | - OS: [e.g. iOS8.1]
37 | - Browser [e.g. stock browser, safari]
38 | - Version [e.g. 22]
39 | 
40 | **Additional context**
41 | Add any other context about the problem here.
42 | 


--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/feature_request.md:
--------------------------------------------------------------------------------
 1 | ---
 2 | name: Feature request
 3 | about: Suggest an idea for this project
 4 | title: "[FEATURE] "
 5 | labels: enhancement
 6 | assignees: ''
 7 | 
 8 | ---
 9 | 
10 | **Is your feature request related to a problem? Please describe.**
11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12 | 
13 | **Describe the solution you'd like**
14 | A clear and concise description of what you want to happen.
15 | 
16 | **Describe alternatives you've considered**
17 | A clear and concise description of any alternative solutions or features you've considered.
18 | 
19 | **Additional context**
20 | Add any other context or screenshots about the feature request here.
21 | 


--------------------------------------------------------------------------------
/.github/pull_request_template.md:
--------------------------------------------------------------------------------
 1 | ## 📖 Description
 2 | <!--Include a description of what has changed and include relevant motivation and context.
 3 | If needed, make sure to list all dependencies that are required for this change.-->
 4 | 
 5 | ## 🛠 Changes
 6 | <!--Please choose one or delete options that are not relevant-->
 7 | 
 8 | - [ ] Bug fix (change that fixes an issue)
 9 | - [ ] Feature (change that adds functionality)
10 | - [ ] Chore (cleanup items not resulting in changes to functionality)
11 | 
12 | This change is (check all that apply)
13 | 
14 | - [ ] Breaking (would cause existing functionality not to work as expected)
15 | - [ ] Non-breaking
16 | - [ ] Requires documentation update
17 | 
18 | ## 📝 Review and Testing Notes
19 | <!--Please add information that would be helpful to the reviewer / tester, such as testing scenarios and anything to pay special attention to.>


--------------------------------------------------------------------------------
/.github/renovate.json:
--------------------------------------------------------------------------------
1 | {
2 |   "$schema": "https://docs.renovatebot.com/renovate-schema.json",
3 |   "extends": [
4 |     "config:recommended"
5 |   ]
6 | }
7 | 


--------------------------------------------------------------------------------
/.github/workflows/integration-test.yml:
--------------------------------------------------------------------------------
 1 | name: Action Integration Test
 2 | 
 3 | on: 
 4 |   push:
 5 |   pull_request:
 6 |     branches: [main]
 7 |     types: [closed]
 8 |   workflow_dispatch:
 9 | 
10 | jobs:
11 |   standard-style:
12 |     runs-on: ubuntu-latest
13 |     steps:
14 |       - uses: actions/checkout@v4
15 |       - name: Lint json file
16 |         uses: ia-eknorr/ignition-lint@v2.1
17 |         with:
18 |           files: tests/cases/PreferredStyle/view.json
19 |           component_style: PascalCase
20 |           parameter_style: camelCase
21 |   regex-style:
22 |     runs-on: ubuntu-latest
23 |     steps:
24 |       - uses: actions/checkout@v4
25 |       - name: Lint json file
26 |         uses: ia-eknorr/ignition-lint@v2.1
27 |         with:
28 |           files: tests/cases/kebab-case/view.json
29 |           component_style: "^[a-z]+(-[a-z]+)*$"
30 |           parameter_style: "^[a-z]+(-[a-z]+)*$"


--------------------------------------------------------------------------------
/.github/workflows/unittest.yml:
--------------------------------------------------------------------------------
 1 | name: Unit tests
 2 | 
 3 | on:
 4 |   push:
 5 |   pull_request:
 6 |     branches: [main]
 7 |     types: [closed]
 8 |   workflow_dispatch:
 9 |       
10 | 
11 | jobs:
12 |   unittest:
13 |     runs-on: ubuntu-latest
14 |     steps:
15 |     - uses: actions/checkout@v4
16 |     - name: Set up Python
17 |       uses: actions/setup-python@v5
18 |       with:
19 |         python-version: 3.12.2
20 |     - name: Install dependencies
21 |       run: |
22 |         python -m pip install --upgrade pip
23 |     - name: Run tests
24 |       run: |
25 |         python -m unittest discover tests


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # VSCode workspace
2 | *.code-workspace
3 | 
4 | # .vscode directory
5 | .vscode
6 | 
7 | # pycache
8 | __pycache__


--------------------------------------------------------------------------------
/.markdownlint.json:
--------------------------------------------------------------------------------
 1 | {
 2 | 	"default": true,
 3 | 	"no-hard-tabs": false,
 4 | 	"whitespace": false,
 5 | 	"MD013": false,
 6 | 	"MD024": false,
 7 | 	"MD046":
 8 | 	{
 9 | 		"style": "fenced"
10 | 	}
11 | }


--------------------------------------------------------------------------------
/.markdownlintignore:
--------------------------------------------------------------------------------
1 | .github/pull_request_template.md
2 | .github/ISSUE_TEMPLATE
3 | CODEOWNERS
4 | 


--------------------------------------------------------------------------------
/.pre-commit-config.yaml:
--------------------------------------------------------------------------------
 1 | ---
 2 | repos:
 3 |   - repo: https://github.com/markdownlint/markdownlint
 4 |     rev: v0.12.0
 5 |     hooks:
 6 |       - id: markdownlint
 7 |         name: Markdown Lint
 8 |         entry: markdownlint
 9 |         language: system
10 |         args:
11 |           - "--config=.markdownlint.json"
12 |           - "--ignore-path=.markdownlintignore"
13 |         types: [markdown]
14 | 
15 |   - repo: https://github.com/pre-commit/mirrors-pylint
16 |     rev: v1.9.1
17 |     hooks:
18 |       - id: pylint
19 |         name: pylint
20 |         entry: pylint
21 |         language: system
22 |         args:
23 |           - "--rcfile=.pylintrc"
24 |           - "--msg-template='{path}:\n  Line {line}: {msg_id}: {msg}'"
25 |         # files: \*.py$
26 |         types: [python]
27 | 


--------------------------------------------------------------------------------
/.pylintrc:
--------------------------------------------------------------------------------
  1 | [MAIN]
  2 | 
  3 | # Analyse import fallback blocks. This can be used to support both Python 2 and
  4 | # 3 compatible code, which means that the block might have code that exists
  5 | # only in one or another interpreter, leading to false positives when analysed.
  6 | analyse-fallback-blocks=no
  7 | 
  8 | # Clear in-memory caches upon conclusion of linting. Useful if running pylint
  9 | # in a server-like mode.
 10 | clear-cache-post-run=no
 11 | 
 12 | # Load and enable all available extensions. Use --list-extensions to see a list
 13 | # all available extensions.
 14 | #enable-all-extensions=
 15 | 
 16 | # In error mode, messages with a category besides ERROR or FATAL are
 17 | # suppressed, and no reports are done by default. Error mode is compatible with
 18 | # disabling specific errors.
 19 | #errors-only=
 20 | 
 21 | # Always return a 0 (non-error) status code, even if lint errors are found.
 22 | # This is primarily useful in continuous integration scripts.
 23 | #exit-zero=
 24 | 
 25 | # A comma-separated list of package or module names from where C extensions may
 26 | # be loaded. Extensions are loading into the active Python interpreter and may
 27 | # run arbitrary code.
 28 | extension-pkg-allow-list=
 29 | 
 30 | # A comma-separated list of package or module names from where C extensions may
 31 | # be loaded. Extensions are loading into the active Python interpreter and may
 32 | # run arbitrary code. (This is an alternative name to extension-pkg-allow-list
 33 | # for backward compatibility.)
 34 | extension-pkg-whitelist=
 35 | 
 36 | # Return non-zero exit code if any of these messages/categories are detected,
 37 | # even if score is above --fail-under value. Syntax same as enable. Messages
 38 | # specified are enabled, while categories only check already-enabled messages.
 39 | fail-on=
 40 | 
 41 | # Specify a score threshold under which the program will exit with error.
 42 | fail-under=10
 43 | 
 44 | # Interpret the stdin as a python script, whose filename needs to be passed as
 45 | # the module_or_package argument.
 46 | #from-stdin=
 47 | 
 48 | # Files or directories to be skipped. They should be base names, not paths.
 49 | ignore=CVS
 50 | 
 51 | # Add files or directories matching the regular expressions patterns to the
 52 | # ignore-list. The regex matches against paths and can be in Posix or Windows
 53 | # format. Because '\\' represents the directory delimiter on Windows systems,
 54 | # it can't be used as an escape character.
 55 | ignore-paths=
 56 | 
 57 | # Files or directories matching the regular expression patterns are skipped.
 58 | # The regex matches against base names, not paths. The default value ignores
 59 | # Emacs file locks
 60 | ignore-patterns=^\.#
 61 | 
 62 | # List of module names for which member attributes should not be checked and
 63 | # will not be imported (useful for modules/projects where namespaces are
 64 | # manipulated during runtime and thus existing member attributes cannot be
 65 | # deduced by static analysis). It supports qualified module names, as well as
 66 | # Unix pattern matching.
 67 | ignored-modules=
 68 | 
 69 | # Python code to execute, usually for sys.path manipulation such as
 70 | # pygtk.require().
 71 | #init-hook=
 72 | 
 73 | # Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the
 74 | # number of processors available to use, and will cap the count on Windows to
 75 | # avoid hangs.
 76 | jobs=1
 77 | 
 78 | # Control the amount of potential inferred values when inferring a single
 79 | # object. This can help the performance when dealing with large functions or
 80 | # complex, nested conditions.
 81 | limit-inference-results=100
 82 | 
 83 | # List of plugins (as comma separated values of python module names) to load,
 84 | # usually to register additional checkers.
 85 | load-plugins=
 86 | 
 87 | # Pickle collected data for later comparisons.
 88 | persistent=yes
 89 | 
 90 | # Resolve imports to .pyi stubs if available. May reduce no-member messages and
 91 | # increase not-an-iterable messages.
 92 | prefer-stubs=no
 93 | 
 94 | # Minimum Python version to use for version dependent checks. Will default to
 95 | # the version used to run pylint.
 96 | py-version=3.12
 97 | 
 98 | # Discover python modules and packages in the file system subtree.
 99 | recursive=no
100 | 
101 | # Add paths to the list of the source roots. Supports globbing patterns. The
102 | # source root is an absolute path or a path relative to the current working
103 | # directory used to determine a package namespace for modules located under the
104 | # source root.
105 | source-roots=
106 | 
107 | # When enabled, pylint would attempt to guess common misconfiguration and emit
108 | # user-friendly hints instead of false-positive error messages.
109 | suggestion-mode=yes
110 | 
111 | # Allow loading of arbitrary C extensions. Extensions are imported into the
112 | # active Python interpreter and may run arbitrary code.
113 | unsafe-load-any-extension=no
114 | 
115 | # In verbose mode, extra non-checker-related info will be displayed.
116 | #verbose=
117 | 
118 | 
119 | [BASIC]
120 | 
121 | # Naming style matching correct argument names.
122 | argument-naming-style=snake_case
123 | 
124 | # Regular expression matching correct argument names. Overrides argument-
125 | # naming-style. If left empty, argument names will be checked with the set
126 | # naming style.
127 | #argument-rgx=
128 | 
129 | # Naming style matching correct attribute names.
130 | attr-naming-style=snake_case
131 | 
132 | # Regular expression matching correct attribute names. Overrides attr-naming-
133 | # style. If left empty, attribute names will be checked with the set naming
134 | # style.
135 | #attr-rgx=
136 | 
137 | # Bad variable names which should always be refused, separated by a comma.
138 | bad-names=foo,
139 |           bar,
140 |           baz,
141 |           toto,
142 |           tutu,
143 |           tata
144 | 
145 | # Bad variable names regexes, separated by a comma. If names match any regex,
146 | # they will always be refused
147 | bad-names-rgxs=
148 | 
149 | # Naming style matching correct class attribute names.
150 | class-attribute-naming-style=any
151 | 
152 | # Regular expression matching correct class attribute names. Overrides class-
153 | # attribute-naming-style. If left empty, class attribute names will be checked
154 | # with the set naming style.
155 | #class-attribute-rgx=
156 | 
157 | # Naming style matching correct class constant names.
158 | class-const-naming-style=UPPER_CASE
159 | 
160 | # Regular expression matching correct class constant names. Overrides class-
161 | # const-naming-style. If left empty, class constant names will be checked with
162 | # the set naming style.
163 | #class-const-rgx=
164 | 
165 | # Naming style matching correct class names.
166 | class-naming-style=PascalCase
167 | 
168 | # Regular expression matching correct class names. Overrides class-naming-
169 | # style. If left empty, class names will be checked with the set naming style.
170 | #class-rgx=
171 | 
172 | # Naming style matching correct constant names.
173 | const-naming-style=UPPER_CASE
174 | 
175 | # Regular expression matching correct constant names. Overrides const-naming-
176 | # style. If left empty, constant names will be checked with the set naming
177 | # style.
178 | #const-rgx=
179 | 
180 | # Minimum line length for functions/classes that require docstrings, shorter
181 | # ones are exempt.
182 | docstring-min-length=10
183 | 
184 | # Naming style matching correct function names.
185 | function-naming-style=snake_case
186 | 
187 | # Regular expression matching correct function names. Overrides function-
188 | # naming-style. If left empty, function names will be checked with the set
189 | # naming style.
190 | #function-rgx=
191 | 
192 | # Good variable names which should always be accepted, separated by a comma.
193 | good-names=i,
194 |            j,
195 |            k,
196 |            ex,
197 |            Run,
198 |            _
199 | 
200 | # Good variable names regexes, separated by a comma. If names match any regex,
201 | # they will always be accepted
202 | good-names-rgxs=
203 | 
204 | # Include a hint for the correct naming format with invalid-name.
205 | include-naming-hint=no
206 | 
207 | # Naming style matching correct inline iteration names.
208 | inlinevar-naming-style=any
209 | 
210 | # Regular expression matching correct inline iteration names. Overrides
211 | # inlinevar-naming-style. If left empty, inline iteration names will be checked
212 | # with the set naming style.
213 | #inlinevar-rgx=
214 | 
215 | # Naming style matching correct method names.
216 | method-naming-style=snake_case
217 | 
218 | # Regular expression matching correct method names. Overrides method-naming-
219 | # style. If left empty, method names will be checked with the set naming style.
220 | #method-rgx=
221 | 
222 | # Naming style matching correct module names.
223 | module-naming-style=snake_case
224 | 
225 | # Regular expression matching correct module names. Overrides module-naming-
226 | # style. If left empty, module names will be checked with the set naming style.
227 | #module-rgx=
228 | 
229 | # Colon-delimited sets of names that determine each other's naming style when
230 | # the name regexes allow several styles.
231 | name-group=
232 | 
233 | # Regular expression which should only match function or class names that do
234 | # not require a docstring.
235 | no-docstring-rgx=^_
236 | 
237 | # List of decorators that produce properties, such as abc.abstractproperty. Add
238 | # to this list to register other decorators that produce valid properties.
239 | # These decorators are taken in consideration only for invalid-name.
240 | property-classes=abc.abstractproperty
241 | 
242 | # Regular expression matching correct type alias names. If left empty, type
243 | # alias names will be checked with the set naming style.
244 | #typealias-rgx=
245 | 
246 | # Regular expression matching correct type variable names. If left empty, type
247 | # variable names will be checked with the set naming style.
248 | #typevar-rgx=
249 | 
250 | # Naming style matching correct variable names.
251 | variable-naming-style=snake_case
252 | 
253 | # Regular expression matching correct variable names. Overrides variable-
254 | # naming-style. If left empty, variable names will be checked with the set
255 | # naming style.
256 | #variable-rgx=
257 | 
258 | 
259 | [CLASSES]
260 | 
261 | # Warn about protected attribute access inside special methods
262 | check-protected-access-in-special-methods=no
263 | 
264 | # List of method names used to declare (i.e. assign) instance attributes.
265 | defining-attr-methods=__init__,
266 |                       __new__,
267 |                       setUp,
268 |                       asyncSetUp,
269 |                       __post_init__
270 | 
271 | # List of member names, which should be excluded from the protected access
272 | # warning.
273 | exclude-protected=_asdict,_fields,_replace,_source,_make,os._exit
274 | 
275 | # List of valid names for the first argument in a class method.
276 | valid-classmethod-first-arg=cls
277 | 
278 | # List of valid names for the first argument in a metaclass class method.
279 | valid-metaclass-classmethod-first-arg=mcs
280 | 
281 | 
282 | [DESIGN]
283 | 
284 | # List of regular expressions of class ancestor names to ignore when counting
285 | # public methods (see R0903)
286 | exclude-too-few-public-methods=
287 | 
288 | # List of qualified class names to ignore when counting class parents (see
289 | # R0901)
290 | ignored-parents=
291 | 
292 | # Maximum number of arguments for function / method.
293 | max-args=7
294 | 
295 | # Maximum number of attributes for a class (see R0902).
296 | max-attributes=15
297 | 
298 | # Maximum number of boolean expressions in an if statement (see R0916).
299 | max-bool-expr=5
300 | 
301 | # Maximum number of branch for function / method body.
302 | max-branches=12
303 | 
304 | # Maximum number of locals for function / method body.
305 | max-locals=15
306 | 
307 | # Maximum number of parents for a class (see R0901).
308 | max-parents=7
309 | 
310 | # Maximum number of public methods for a class (see R0904).
311 | max-public-methods=20
312 | 
313 | # Maximum number of return / yield for function / method body.
314 | max-returns=6
315 | 
316 | # Maximum number of statements in function / method body.
317 | max-statements=50
318 | 
319 | # Minimum number of public methods for a class (see R0903).
320 | min-public-methods=2
321 | 
322 | 
323 | [EXCEPTIONS]
324 | 
325 | # Exceptions that will emit a warning when caught.
326 | overgeneral-exceptions=builtins.BaseException,builtins.Exception
327 | 
328 | 
329 | [FORMAT]
330 | 
331 | # Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
332 | expected-line-ending-format=
333 | 
334 | # Regexp for a line that is allowed to be longer than the limit.
335 | ignore-long-lines=^\s*(# )?<?https?://\S+>?$
336 | 
337 | # Number of spaces of indent required inside a hanging or continued line.
338 | indent-after-paren=4
339 | 
340 | # String used as indentation unit. This is usually "    " (4 spaces) or "\t" (1
341 | # tab).
342 | indent-string='    '
343 | 
344 | # Maximum number of characters on a single line.
345 | max-line-length=140
346 | 
347 | # Maximum number of lines in a module.
348 | max-module-lines=1000
349 | 
350 | # Allow the body of a class to be on the same line as the declaration if body
351 | # contains single statement.
352 | single-line-class-stmt=no
353 | 
354 | # Allow the body of an if to be on the same line as the test if there is no
355 | # else.
356 | single-line-if-stmt=no
357 | 
358 | 
359 | [IMPORTS]
360 | 
361 | # List of modules that can be imported at any level, not just the top level
362 | # one.
363 | allow-any-import-level=
364 | 
365 | # Allow explicit reexports by alias from a package __init__.
366 | allow-reexport-from-package=no
367 | 
368 | # Allow wildcard imports from modules that define __all__.
369 | allow-wildcard-with-all=no
370 | 
371 | # Deprecated modules which should not be used, separated by a comma.
372 | deprecated-modules=
373 | 
374 | # Output a graph (.gv or any supported image format) of external dependencies
375 | # to the given file (report RP0402 must not be disabled).
376 | ext-import-graph=
377 | 
378 | # Output a graph (.gv or any supported image format) of all (i.e. internal and
379 | # external) dependencies to the given file (report RP0402 must not be
380 | # disabled).
381 | import-graph=
382 | 
383 | # Output a graph (.gv or any supported image format) of internal dependencies
384 | # to the given file (report RP0402 must not be disabled).
385 | int-import-graph=
386 | 
387 | # Force import order to recognize a module as part of the standard
388 | # compatibility libraries.
389 | known-standard-library=
390 | 
391 | # Force import order to recognize a module as part of a third party library.
392 | known-third-party=enchant
393 | 
394 | # Couples of modules and preferred modules, separated by a comma.
395 | preferred-modules=
396 | 
397 | 
398 | [LOGGING]
399 | 
400 | # The type of string formatting that logging methods do. `old` means using %
401 | # formatting, `new` is for `{}` formatting.
402 | logging-format-style=old
403 | 
404 | # Logging modules to check that the string format arguments are in logging
405 | # function parameter format.
406 | logging-modules=logging
407 | 
408 | 
409 | [MESSAGES CONTROL]
410 | 
411 | # Only show warnings with the listed confidence levels. Leave empty to show
412 | # all. Valid levels: HIGH, CONTROL_FLOW, INFERENCE, INFERENCE_FAILURE,
413 | # UNDEFINED.
414 | confidence=HIGH,
415 |            CONTROL_FLOW,
416 |            INFERENCE,
417 |            INFERENCE_FAILURE,
418 |            UNDEFINED
419 | 
420 | # Disable the message, report, category or checker with the given id(s). You
421 | # can either give multiple identifiers separated by comma (,) or put this
422 | # option multiple times (only on the command line, not in the configuration
423 | # file where it should appear only once). You can also use "--disable=all" to
424 | # disable everything first and then re-enable specific checks. For example, if
425 | # you want to run only the similarities checker, you can use "--disable=all
426 | # --enable=similarities". If you want to run only the classes checker, but have
427 | # no Warning level messages displayed, use "--disable=all --enable=classes
428 | # --disable=W".
429 | disable=raw-checker-failed,
430 |         bad-inline-option,
431 |         locally-disabled,
432 |         file-ignored,
433 |         suppressed-message,
434 |         useless-suppression,
435 |         deprecated-pragma,
436 |         use-symbolic-message-instead,
437 |         use-implicit-booleaness-not-comparison-to-string,
438 |         use-implicit-booleaness-not-comparison-to-zero
439 | 
440 | # Enable the message, report, category or checker with the given id(s). You can
441 | # either give multiple identifier separated by comma (,) or put this option
442 | # multiple time (only on the command line, not in the configuration file where
443 | # it should appear only once). See also the "--disable" option for examples.
444 | enable=
445 | 
446 | 
447 | [METHOD_ARGS]
448 | 
449 | # List of qualified names (i.e., library.method) which require a timeout
450 | # parameter e.g. 'requests.api.get,requests.api.post'
451 | timeout-methods=requests.api.delete,requests.api.get,requests.api.head,requests.api.options,requests.api.patch,requests.api.post,requests.api.put,requests.api.request
452 | 
453 | 
454 | [MISCELLANEOUS]
455 | 
456 | # List of note tags to take in consideration, separated by a comma.
457 | notes=FIXME,
458 |       XXX,
459 |       TODO
460 | 
461 | # Regular expression of note tags to take in consideration.
462 | notes-rgx=
463 | 
464 | 
465 | [REFACTORING]
466 | 
467 | # Maximum number of nested blocks for function / method body
468 | max-nested-blocks=5
469 | 
470 | # Complete name of functions that never returns. When checking for
471 | # inconsistent-return-statements if a never returning function is called then
472 | # it will be considered as an explicit return statement and no message will be
473 | # printed.
474 | never-returning-functions=sys.exit,argparse.parse_error
475 | 
476 | # Let 'consider-using-join' be raised when the separator to join on would be
477 | # non-empty (resulting in expected fixes of the type: ``"- " + " -
478 | # ".join(items)``)
479 | suggest-join-with-non-empty-separator=yes
480 | 
481 | 
482 | [REPORTS]
483 | 
484 | # Python expression which should return a score less than or equal to 10. You
485 | # have access to the variables 'fatal', 'error', 'warning', 'refactor',
486 | # 'convention', and 'info' which contain the number of messages in each
487 | # category, as well as 'statement' which is the total number of statements
488 | # analyzed. This score is used by the global evaluation report (RP0004).
489 | evaluation=max(0, 0 if fatal else 10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10))
490 | 
491 | # Template used to display messages. This is a python new-style format string
492 | # used to format the message information. See doc for all details.
493 | msg-template=
494 | 
495 | # Set the output format. Available formats are: text, parseable, colorized,
496 | # json2 (improved json format), json (old json format) and msvs (visual
497 | # studio). You can also give a reporter class, e.g.
498 | # mypackage.mymodule.MyReporterClass.
499 | #output-format=
500 | 
501 | # Tells whether to display a full report or only the messages.
502 | reports=no
503 | 
504 | # Activate the evaluation score.
505 | score=yes
506 | 
507 | 
508 | [SIMILARITIES]
509 | 
510 | # Comments are removed from the similarity computation
511 | ignore-comments=yes
512 | 
513 | # Docstrings are removed from the similarity computation
514 | ignore-docstrings=yes
515 | 
516 | # Imports are removed from the similarity computation
517 | ignore-imports=yes
518 | 
519 | # Signatures are removed from the similarity computation
520 | ignore-signatures=yes
521 | 
522 | # Minimum lines number of a similarity.
523 | min-similarity-lines=4
524 | 
525 | 
526 | [SPELLING]
527 | 
528 | # Limits count of emitted suggestions for spelling mistakes.
529 | max-spelling-suggestions=4
530 | 
531 | # Spelling dictionary name. No available dictionaries : You need to install
532 | # both the python package and the system dependency for enchant to work.
533 | spelling-dict=
534 | 
535 | # List of comma separated words that should be considered directives if they
536 | # appear at the beginning of a comment and should not be checked.
537 | spelling-ignore-comment-directives=fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy:
538 | 
539 | # List of comma separated words that should not be checked.
540 | spelling-ignore-words=
541 | 
542 | # A path to a file that contains the private dictionary; one word per line.
543 | spelling-private-dict-file=
544 | 
545 | # Tells whether to store unknown words to the private dictionary (see the
546 | # --spelling-private-dict-file option) instead of raising a message.
547 | spelling-store-unknown-words=no
548 | 
549 | 
550 | [STRING]
551 | 
552 | # This flag controls whether inconsistent-quotes generates a warning when the
553 | # character used as a quote delimiter is used inconsistently within a module.
554 | check-quote-consistency=no
555 | 
556 | # This flag controls whether the implicit-str-concat should generate a warning
557 | # on implicit string concatenation in sequences defined over several lines.
558 | check-str-concat-over-line-jumps=no
559 | 
560 | 
561 | [TYPECHECK]
562 | 
563 | # List of decorators that produce context managers, such as
564 | # contextlib.contextmanager. Add to this list to register other decorators that
565 | # produce valid context managers.
566 | contextmanager-decorators=contextlib.contextmanager
567 | 
568 | # List of members which are set dynamically and missed by pylint inference
569 | # system, and so shouldn't trigger E1101 when accessed. Python regular
570 | # expressions are accepted.
571 | generated-members=
572 | 
573 | # Tells whether to warn about missing members when the owner of the attribute
574 | # is inferred to be None.
575 | ignore-none=yes
576 | 
577 | # This flag controls whether pylint should warn about no-member and similar
578 | # checks whenever an opaque object is returned when inferring. The inference
579 | # can return multiple potential results while evaluating a Python object, but
580 | # some branches might not be evaluated, which results in partial inference. In
581 | # that case, it might be useful to still emit no-member and other checks for
582 | # the rest of the inferred objects.
583 | ignore-on-opaque-inference=yes
584 | 
585 | # List of symbolic message names to ignore for Mixin members.
586 | ignored-checks-for-mixins=no-member,
587 |                           not-async-context-manager,
588 |                           not-context-manager,
589 |                           attribute-defined-outside-init
590 | 
591 | # List of class names for which member attributes should not be checked (useful
592 | # for classes with dynamically set attributes). This supports the use of
593 | # qualified names.
594 | ignored-classes=optparse.Values,thread._local,_thread._local,argparse.Namespace
595 | 
596 | # Show a hint with possible names when a member name was not found. The aspect
597 | # of finding the hint is based on edit distance.
598 | missing-member-hint=yes
599 | 
600 | # The minimum edit distance a name should have in order to be considered a
601 | # similar match for a missing member name.
602 | missing-member-hint-distance=1
603 | 
604 | # The total number of similar names that should be taken in consideration when
605 | # showing a hint for a missing member.
606 | missing-member-max-choices=1
607 | 
608 | # Regex pattern to define which classes are considered mixins.
609 | mixin-class-rgx=.*[Mm]ixin
610 | 
611 | # List of decorators that change the signature of a decorated function.
612 | signature-mutators=
613 | 
614 | 
615 | [VARIABLES]
616 | 
617 | # List of additional names supposed to be defined in builtins. Remember that
618 | # you should avoid defining new builtins when possible.
619 | additional-builtins=
620 | 
621 | # Tells whether unused global variables should be treated as a violation.
622 | allow-global-unused-variables=yes
623 | 
624 | # List of names allowed to shadow builtins
625 | allowed-redefined-builtins=
626 | 
627 | # List of strings which can identify a callback function by name. A callback
628 | # name must start or end with one of those strings.
629 | callbacks=cb_,
630 |           _cb
631 | 
632 | # A regular expression matching the name of dummy variables (i.e. expected to
633 | # not be used).
634 | dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_
635 | 
636 | # Argument names that match this expression will be ignored.
637 | ignored-argument-names=_.*|^ignored_|^unused_
638 | 
639 | # Tells whether we should check for unused import in __init__ files.
640 | init-import=no
641 | 
642 | # List of qualified module names which can have objects that can redefine
643 | # builtins.
644 | redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io
645 | 


--------------------------------------------------------------------------------
/.python-version:
--------------------------------------------------------------------------------
1 | 3.12.2


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2024 Eric Knorr
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # Ignition `view.json` Linter
  2 | 
  3 | This GitHub Action performs linting on Ignition `view.json` files to ensure proper naming conventions are followed for component names and parameter keys.
  4 | 
  5 | ## Inputs
  6 | 
  7 | ### `files` (optional)
  8 | 
  9 | Comma-separated list of paths or glob patterns to the Ignition `view.json` files to be linted. Glob patterns are supported, e.g., `**/view.json` to match all `view.json` files recursively.
 10 | 
 11 | The default value is `**/view.json` to capture all Perspective views.
 12 | 
 13 | ### `component_style` (optional)
 14 | 
 15 | Naming convention style for components. Cannot be used with `component_style_rgx`.
 16 | 
 17 | Options:
 18 | 
 19 | * `PascalCase`
 20 | * `camelCase`
 21 | * `snake_case`
 22 | * `UPPER_CASE`
 23 | * `Title Case`
 24 | 
 25 | ### `parameter_style` (optional)
 26 | 
 27 | Naming convention style for parameters. Cannot be used with `parameter_style_rgx`.
 28 | 
 29 | Options:
 30 | 
 31 | * `PascalCase`
 32 | * `camelCase`
 33 | * `snake_case`
 34 | * `UPPER_CASE`
 35 | 
 36 | ### `component_style_rgx` (optional)
 37 | 
 38 | Regex pattern for naming convention style of components. Cannot be used with `component_style`.
 39 | 
 40 | ### `parameter_style_rgx` (optional)
 41 | 
 42 | Regex pattern for naming convention style of parameters. Cannot be used with `parameter_style`.
 43 | 
 44 | > [!IMPORTANT]
 45 | > While the following inputs are optional, at least one input of each type is required to define the style for that type. Define naming styles for components and parameters using either predefined (*_style) or regex (*_style_rgx) conventions. For example, to define the style for components, you must use the input variable `component_style` or `component_style_rgx`, but not both.
 46 | 
 47 | ### `allow_acronyms` (optional)
 48 | 
 49 | Boolean value to allow acronyms in component and parameter names. The default value is `false`.
 50 | 
 51 | This input is useful when using `camelCase`, `PascalCase` or `Title Case` styles, where acronyms are typically written in uppercase. When set to `true`, acronyms are allowed in component and parameter names. When set to `false`, acronyms are not allowed in component and parameter names.
 52 | 
 53 | > [!CAUTION]
 54 | > This input can have unexpected results, since it allows things that are not *actually* in the pattern. For instance, if you have specified `camelCase` and `allow_acronyms` is `true`, the pattern will allow `URL`, `USPopulation`, and `myGPSLocation` as valid names, even though they are not camelCase. There are all sorts of edge cases like this, so be careful when using this input.
 55 | 
 56 | ## Outputs
 57 | 
 58 | None
 59 | 
 60 | ## Usage
 61 | 
 62 | To use this Action in your workflow, create a workflow file (e.g., `.github/workflows/lint-ignition-views.yml`) in your repository and add one of the following configurations:
 63 | 
 64 | * Standard supported style definition
 65 | 
 66 |   ```yaml
 67 |   jobs:
 68 |     lint:
 69 |       runs-on: ubuntu-latest
 70 |       steps:
 71 |         - uses: actions/checkout@v4
 72 |         - name: Lint files
 73 |           uses: ia-eknorr/ignition-lint@v2.2
 74 |           with:
 75 |             files: "path/to/your/view.json"
 76 |             component_style: "PascalCase"
 77 |             parameter_style: "camelCase"
 78 |   ```
 79 | 
 80 | * Regex style definition (kebab-case example)
 81 | 
 82 |   ```yaml
 83 |   jobs:
 84 |     lint:
 85 |       runs-on: ubuntu-latest
 86 |       steps:
 87 |         - uses: actions/checkout@v4
 88 |         - name: Lint files
 89 |           uses: ia-eknorr/ignition-lint@v2.2
 90 |           with:
 91 |             files: "path/to/your/view.json"
 92 |             component_style: "^[a-z]+(-[a-z]+)*$"
 93 |             parameter_style: "^[a-z]+(-[a-z]+)*$"
 94 |   ```
 95 | 
 96 | ### Action scenarios
 97 | 
 98 | * No style conflicts
 99 |   * The action will pass
100 | * No files given
101 |   * The action will pass
102 | * Style conflicts are found
103 |   * The action will fail with logs showing the bad names
104 |   ![test-failure](images/test-failure.png)
105 | 


--------------------------------------------------------------------------------
/action.yml:
--------------------------------------------------------------------------------
 1 | name: "Ignition Lint"
 2 | description: "Action to lint ignition view.json files"
 3 | author: "Eric Knorr"
 4 | 
 5 | inputs:
 6 |   files:
 7 |     description: "Comma-separated list of ignition files to lint"
 8 |     required: false
 9 |   component_style:
10 |     description: "Naming convention style for components"
11 |     required: false
12 |   parameter_style:
13 |     description: "Naming convention style for parameters"
14 |     required: false
15 |   component_style_rgx:
16 |     description: "Regex pattern for naming convention style of components"
17 |     required: false
18 |   parameter_style_rgx:
19 |     description: "Regex pattern for naming convention style of parameters"
20 |     required: false
21 |   allow_acronyms:
22 |     description: "Allow acronyms in component and parameter names"
23 |     required: false
24 |     default: "false"
25 | 
26 | branding:
27 |   icon: "zap"
28 |   color: "orange"
29 | 
30 | runs:
31 |   using: "composite"
32 |   steps:
33 |     - name: Lint ignition view.json files
34 |       run: |
35 |         python ${{ github.action_path }}/src/ignition_lint.py \
36 |           --files "${{ inputs.files }}" \
37 |           --component-style "${{ inputs.component_style }}" \
38 |           --parameter-style "${{ inputs.parameter_style }}" \
39 |           --component-style-rgx "${{ inputs.component_style_rgx }}" \
40 |           --parameter-style-rgx "${{ inputs.parameter_style_rgx }}"
41 |           --allow-acronyms "${{ inputs.allow_acronyms }}"
42 |       shell: bash
43 |       env:
44 |         INPUT_FILES: ${{ inputs.files }}
45 |         INPUT_COMPONENT_STYLE: ${{ inputs.component_style }}
46 |         INPUT_PARAMETER_STYLE: ${{ inputs.parameter_style }}
47 |         INPUT_COMPONENT_STYLE_RGX: ${{ inputs.component_style_rgx }}
48 |         INPUT_PARAMETER_STYLE_RGX: ${{ inputs.parameter_style_rgx }}
49 |         INPUT_ALLOW_ACRONYMS: ${{ inputs.allow_acronyms }}
50 | 


--------------------------------------------------------------------------------
/images/test-failure.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ia-eknorr/ignition-lint/0a9e66a089e76d6a50887ff6a6b735706ececced/images/test-failure.png


--------------------------------------------------------------------------------
/src/checker.py:
--------------------------------------------------------------------------------
 1 | """Module for checking naming styles of variables, functions, classes, etc."""
 2 | import re
 3 | 
 4 | class StyleChecker:
 5 |     """Class for defining different naming styles and checking names against them."""
 6 | 
 7 |     @staticmethod
 8 |     def is_snake_case(name: str) -> bool:
 9 |         """Check if the name follows snake_case convention."""
10 |         pattern = r"^[a-z][a-z0-9_]*$"
11 |         return bool(re.match(pattern, name))
12 | 
13 |     def is_camel_case(self, name: str) -> bool:
14 |         """Check if the name follows camelCase convention."""
15 |         if self.allow_acronyms:
16 |             pattern = r"^(?:[a-z]+|[A-Z]+(?=[A-Z][a-z]|\d|\s|$)|\d+)(?:[A-Z]*(?=[A-Z][a-z]|\d|\s|$)|\d*)[a-zA-Z0-9]*$"
17 |         else:
18 |             pattern = r"^[a-z][a-z0-9]*(([A-Z][a-z0-9]+)*[A-Z]?|([a-z0-9]+[A-Z])*|[A-Z])$"
19 |         return bool(re.match(pattern, name))
20 | 
21 |     def is_pascal_case(self, name: str) -> bool:
22 |         """Check if the name follows PascalCase convention."""
23 |         if self.allow_acronyms:
24 |             pattern = r"^(([A-Z][a-z0-9]+)|([A-Z]+(?=[A-Z][a-z]|\d|\W|$)|\d+))([A-Z][a-z0-9]+|[A-Z]+(?=[A-Z][a-z]|\d|\W|$)|\d+)*$"
25 |         else:
26 |             pattern = r"^[A-Z](([a-z0-9]+[A-Z]?)*)$"
27 |         return bool(re.match(pattern, name))
28 | 
29 |     @staticmethod
30 |     def is_upper_case(name: str) -> bool:
31 |         """Check if the name follows UPPER_CASE convention."""
32 |         pattern = r"^[A-Z0-9_]+$"
33 |         return bool(re.match(pattern, name))
34 | 
35 |     def is_title_case(self, name: str) -> bool:
36 |         """Check if the name follows Title Case convention."""
37 |         if self.allow_acronyms:
38 |             pattern = r"^(?:[A-Z]+|[A-Z][a-z0-9]+)(?:\s(?:[A-Z]+|\d+[A-Za-z]*|[A-Z][a-z0-9]+))*$"
39 |         else:
40 |             pattern = r"^[A-Z][a-z0-9]+(?:\s(?:[A-Z][a-z0-9]+|\d+))*$"
41 |         return bool(re.match(pattern, name))
42 | 
43 |     @staticmethod
44 |     def is_any(_: str) -> bool:
45 |         """Any name is considered correct."""
46 |         return True
47 | 
48 |     def __init__(self, style_name, allow_acronyms=False):
49 |         self.style_name = style_name
50 |         self.allow_acronyms = allow_acronyms
51 |         self.style_check_function = self._get_style_check_function(style_name)
52 | 
53 |     def _get_style_check_function(self, style_name):
54 |         naming_styles = {
55 |             "snake_case": self.is_snake_case,
56 |             "camelCase": self.is_camel_case,
57 |             "PascalCase": self.is_pascal_case,
58 |             "UPPER_CASE": self.is_upper_case,
59 |             "Title Case": self.is_title_case,
60 |             "any": self.is_any,
61 |         }
62 |         if style_name in naming_styles:
63 |             return naming_styles[style_name]
64 |         return self._generate_regex_check_function(self.style_name)
65 | 
66 |     def _generate_regex_check_function(self, pattern):
67 |         regex_pattern = re.compile(pattern)
68 |         return lambda name: bool(regex_pattern.match(name))
69 | 
70 |     def is_correct_style(self, name):
71 |         return self.style_check_function(name)
72 | 


--------------------------------------------------------------------------------
/src/ignition_lint.py:
--------------------------------------------------------------------------------
  1 | """ This script is used to lint Ignition view.json files for style inconsistencies in component and parameter names. """
  2 | 
  3 | import json
  4 | import sys
  5 | import argparse
  6 | import os
  7 | import glob
  8 | import re
  9 | from checker import StyleChecker
 10 | 
 11 | 
 12 | class JsonLinter:
 13 |     """Class for linting Ignition view.json files for style inconsistencies in component and parameter names.
 14 | 
 15 |     Attributes:
 16 | 
 17 |     component_style (str): The naming convention style for components.
 18 |     parameter_style (str): The naming convention style for parameters.
 19 |     component_style_rgx (str): The regex pattern for naming convention style of components.
 20 |     parameter_style_rgx (str): The regex pattern for naming convention style of parameters.
 21 |     allow_acronyms (bool): Whether to allow acronyms in the names.
 22 |     errors (dict): Dictionary to store the errors found in the files.
 23 |     files_linted (int): The number of files linted.
 24 |     parameter_areas (list): The areas in the file where parameters are found.
 25 |     component_areas (list): The areas in the file where components are found.
 26 |     keys_to_skip (list): The keys to skip while traversing the file.
 27 |     component_style_checker (StyleChecker): The StyleChecker object for component names.
 28 |     parameter_style_checker (StyleChecker): The StyleChecker object for parameter names
 29 | 
 30 |     Usage:
 31 |     linter = JsonLinter(component_style="PascalCase", parameter_style="snake_case")
 32 |     num_errors = linter.lint_file("path/to/file.json")
 33 |     """
 34 | 
 35 |     def __init__(
 36 |         self,
 37 |         component_style,
 38 |         parameter_style,
 39 |         component_style_rgx,
 40 |         parameter_style_rgx,
 41 |         allow_acronyms=False,
 42 |     ):
 43 |         # Check if both named style and regex style are provided for the same type
 44 |         if component_style_rgx not in [None, ""] and component_style not in [None, ""]:
 45 |             message = "Cannot specify both (component_style: {}, component_style_rgx: {}). Please choose one or the other."
 46 |             raise ValueError(message.format(component_style, component_style_rgx))
 47 | 
 48 |         if parameter_style_rgx not in [None, ""] and parameter_style not in [None, ""]:
 49 |             message = "Cannot specify both (parameter_style: {}, parameter_style_rgx: {}). Please choose one or the other."
 50 |             raise ValueError(message.format(parameter_style, parameter_style_rgx))
 51 | 
 52 |         if component_style_rgx is None and component_style is None:
 53 |             raise ValueError(
 54 |                 "Component naming style not specified. Use either (component_style) or (component_style_rgx)."
 55 |             )
 56 | 
 57 |         if parameter_style_rgx is None and parameter_style is None:
 58 |             raise ValueError(
 59 |                 "Parameter naming style not specified. Use either (parameter_style) or (parameter_style_rgx)."
 60 |             )
 61 | 
 62 |         if parameter_style == "Title Case":
 63 |             raise ValueError(
 64 |                 "Title Case is not a valid parameter naming style. Please use a different style."
 65 |             )
 66 | 
 67 |         self.parameter_areas = ["custom", "params"]
 68 |         self.component_areas = ["root", "children"]
 69 |         self.keys_to_skip = [
 70 |             "props",
 71 |             "position",
 72 |             "type",
 73 |             "meta",
 74 |             "propConfig",
 75 |             "scripts",
 76 |         ]
 77 |         self.component_style = component_style
 78 |         self.parameter_style = parameter_style
 79 |         self.component_style_rgx = component_style_rgx
 80 |         self.parameter_style_rgx = parameter_style_rgx
 81 |         self.allow_acronyms = allow_acronyms
 82 |         self.errors = {"components": [], "parameters": []}
 83 |         self.files_linted = 0
 84 | 
 85 |         self.component_style_checker = (
 86 |             StyleChecker(component_style_rgx, allow_acronyms)
 87 |             if component_style_rgx not in [None, ""]
 88 |             else StyleChecker(component_style, allow_acronyms)
 89 |         )
 90 |         self.parameter_style_checker = (
 91 |             StyleChecker(parameter_style_rgx, allow_acronyms)
 92 |             if parameter_style_rgx not in [None, ""]
 93 |             else StyleChecker(parameter_style, allow_acronyms)
 94 |         )
 95 | 
 96 |     def lint_file(self, file_path: str) -> int:
 97 |         """Lint the file at the given path.
 98 | 
 99 |         Args:
100 |         file_path (str): The path to the file to be linted.
101 | 
102 |         Returns:
103 |         int: The number of errors found in the file.
104 |         """
105 |         # Check for presence of glob special characters
106 |         if re.search(r"[\*\?\[\]]", file_path):
107 |             # If the file_path contains a glob pattern
108 |             files = glob.glob(file_path, recursive=True)
109 |             if not files:
110 |                 print(f"No files found matching the pattern: {file_path}")
111 |                 return 0
112 | 
113 |             num_errors = 0
114 |             for file in files:
115 |                 num_errors += self.lint_single_file(file)
116 |             return num_errors
117 |         return self.lint_single_file(file_path)
118 | 
119 |     def lint_single_file(self, file_path: str) -> int:
120 |         """Lint a single file.
121 | 
122 |         Args:
123 |         file_path (str): The path to the file to be linted.
124 | 
125 |         Returns:
126 |         int: The number of errors found in the file.
127 |         """
128 |         if not os.path.exists(file_path):
129 |             print(f"File not found: {file_path}")
130 |             return 0
131 | 
132 |         self.errors = {"components": [], "parameters": []}
133 | 
134 |         with open(file_path, "r", encoding="utf-8") as file:
135 |             try:
136 |                 data = json.load(file)
137 |                 self.check_component_names(data, self.errors)
138 |             except json.JSONDecodeError as e:
139 |                 print(f"Error parsing file {file_path}: {e}")
140 |                 return 0
141 | 
142 |         self.print_errors(file_path, self.errors)
143 |         num_errors = len(self.errors["components"]) + len(self.errors["parameters"])
144 | 
145 |         self.files_linted += 1
146 |         return num_errors
147 | 
148 |     def check_parameter_names(self, data, errors: dict, parent_key: str = ""):
149 |         """Check the parameter names in the data.
150 | 
151 |         Args:
152 |         data (dict): The data to be checked.
153 |         errors (dict): The dictionary to store the errors found.
154 |         parent_key (str): The parent key of the data.
155 | 
156 |         Returns:
157 |         None
158 |         """
159 |         for key, value in data.items():
160 |             if key in self.keys_to_skip:
161 |                 continue
162 | 
163 |             # If key has the format of a dataset, skip to next key
164 |             if key.startswith("$"):
165 |                 continue
166 | 
167 |             if isinstance(value, dict):
168 |                 self.check_parameter_names(value, errors, f"{parent_key}.{key}")
169 |             elif (
170 |                 not self.parameter_style_checker.is_correct_style(key)
171 |                 and "props.params" not in parent_key
172 |             ):
173 |                 errors["parameters"].append(
174 |                     f"{parent_key}.{key}" if parent_key else key
175 |                 )
176 | 
177 |     def check_component_names(self, value, errors: dict, parent_key: str = ""):
178 |         """Check the component names in the data.
179 | 
180 |         Args:
181 |         value (dict): The data to be checked.
182 |         errors (dict): The dictionary to store the errors found.
183 |         parent_key (str): The parent key of the data.
184 | 
185 |         Returns:
186 |         None
187 |         """
188 |         component_name = value.get("meta", {}).get("name")
189 |         if component_name == "root":
190 |             parent_key = component_name
191 |         elif component_name is not None:
192 |             parent_key = f"{parent_key}/{component_name}"
193 |             if not self.component_style_checker.is_correct_style(component_name):
194 |                 errors["components"].append(parent_key)
195 | 
196 |         for key, element in value.items():
197 |             if key in self.keys_to_skip:
198 |                 continue
199 | 
200 |             if isinstance(element, dict):
201 |                 if key in self.parameter_areas:
202 |                     if not parent_key:
203 |                         parent_key = "view"
204 |                     self.check_parameter_names(element, errors, f"{parent_key}.{key}")
205 |                 else:
206 |                     self.check_component_names(element, errors, parent_key)
207 |             elif isinstance(element, list):
208 |                 parent_of_list = parent_key
209 |                 for item in element:
210 |                     self.check_component_names(item, errors, parent_key)
211 |                     parent_key = parent_of_list
212 | 
213 |     def print_errors(self, file_path: str, errors: dict) -> None:
214 |         """Print the errors found in the file.
215 | 
216 |         Args:
217 |         file_path (str): The path to the file.
218 |         errors (dict): The errors found in the file.
219 | 
220 |         Returns:
221 |         None
222 |         """
223 |         error_logs = []
224 |         if errors["components"]:
225 |             if self.component_style_rgx:
226 |                 error_logs.append(
227 |                     f"  Component names should follow pattern '{self.component_style_rgx}':"
228 |                 )
229 |             else:
230 |                 error_logs.append(
231 |                     f"  Component names should be in {self.component_style}:"
232 |                 )
233 |             error_logs.extend([f"    - {error}" for error in errors["components"]])
234 |         if errors["parameters"]:
235 |             if self.parameter_style_rgx:
236 |                 error_logs.append(
237 |                     f"  Parameter names should follow pattern '{self.parameter_style_rgx}':"
238 |                 )
239 |             else:
240 |                 error_logs.append(
241 |                     f"  Parameter keys should be in {self.parameter_style}:"
242 |                 )
243 |             error_logs.extend([f"    - {error}" for error in errors["parameters"]])
244 | 
245 |         if error_logs:
246 |             print(f"\nError in file: {file_path}")
247 |             for error_log in error_logs:
248 |                 print(error_log)
249 | 
250 | 
251 | def main():
252 |     """Main function to lint the Ignition view.json files for style inconsistencies in component and parameter names."""
253 | 
254 |     parser = argparse.ArgumentParser()
255 |     # NOTE: The comma separated list vs the space separated list is because with a Space Separated list option you
256 |     # Cannot truly support Title Case with a Space Case formatted file, it will capture it as a separate file path
257 |     parser.add_argument(
258 |         "--files",
259 |         default="**/view.json",
260 |         help="Comma-separated list of ignition files or glob patterns to lint",
261 |     )
262 |     parser.add_argument(
263 |         "--component-style", help="Naming convention style for components"
264 |     )
265 |     parser.add_argument(
266 |         "--parameter-style", help="Naming convention style for parameters"
267 |     )
268 |     parser.add_argument(
269 |         "--component-style-rgx",
270 |         help="Regex pattern for naming convention style of components",
271 |     )
272 |     parser.add_argument(
273 |         "--parameter-style-rgx",
274 |         help="Regex pattern for naming convention style of parameters",
275 |     )
276 |     args = parser.parse_args()
277 | 
278 |     input_patterns = args.files.split(",")
279 |     input_files = []
280 |     for pattern in input_patterns:
281 |         input_files.extend(glob.glob(pattern, recursive=True))
282 | 
283 |     if not input_files:
284 |         print("No files found matching the specified patterns")
285 |         sys.exit(0)
286 | 
287 |     linter = JsonLinter(
288 |         component_style=args.component_style,
289 |         parameter_style=args.parameter_style,
290 |         component_style_rgx=args.component_style_rgx,
291 |         parameter_style_rgx=args.parameter_style_rgx,
292 |     )
293 |     number_of_errors = 0
294 | 
295 |     for file_path in input_files:
296 |         number_of_errors += linter.lint_file(file_path)
297 | 
298 |     if not number_of_errors:
299 |         print("No style inconsistencies found")
300 |         sys.exit(0)
301 |     sys.exit(1)
302 | 
303 | 
304 | if __name__ == "__main__":
305 |     main()
306 | 


--------------------------------------------------------------------------------
/tests/cases/PascalCase/resource.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "scope": "G",
 3 |   "version": 1,
 4 |   "restricted": false,
 5 |   "overridable": true,
 6 |   "files": [
 7 |     "view.json",
 8 |     "thumbnail.png"
 9 |   ],
10 |   "attributes": {
11 |     "lastModification": {
12 |       "actor": "eknorr",
13 |       "timestamp": "2024-02-23T00:55:24Z"
14 |     },
15 |     "lastModificationSignature": "207e2d90855bad63e0832790f1a3f50fccadf1f4c592ba17dbfde44b92e5c9c3"
16 |   }
17 | }


--------------------------------------------------------------------------------
/tests/cases/PascalCase/thumbnail.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ia-eknorr/ignition-lint/0a9e66a089e76d6a50887ff6a6b735706ececced/tests/cases/PascalCase/thumbnail.png


--------------------------------------------------------------------------------
/tests/cases/PascalCase/view.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "custom": {
 3 |     "CustomViewParam": "value"
 4 |   },
 5 |   "params": {
 6 |     "ViewParam": "value"
 7 |   },
 8 |   "propConfig": {
 9 |     "custom.CustomViewParam": {
10 |       "persistent": true
11 |     },
12 |     "params.ViewParam": {
13 |       "paramDirection": "input",
14 |       "persistent": true
15 |     }
16 |   },
17 |   "props": {},
18 |   "root": {
19 |     "children": [
20 |       {
21 |         "custom": {
22 |           "ComponentCustomParam": "value"
23 |         },
24 |         "meta": {
25 |           "name": "IconPascalCase"
26 |         },
27 |         "position": {
28 |           "basis": "30px"
29 |         },
30 |         "props": {
31 |           "path": "material/insert_emoticon"
32 |         },
33 |         "type": "ia.display.icon"
34 |       }
35 |     ],
36 |     "custom": {
37 |       "RootCustomParam": "value"
38 |     },
39 |     "meta": {
40 |       "name": "root"
41 |     },
42 |     "props": {
43 |       "direction": "column"
44 |     },
45 |     "type": "ia.container.flex"
46 |   }
47 | }


--------------------------------------------------------------------------------
/tests/cases/PreferredStyle/resource.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "scope": "G",
 3 |   "version": 1,
 4 |   "restricted": false,
 5 |   "overridable": true,
 6 |   "files": [
 7 |     "view.json",
 8 |     "thumbnail.png"
 9 |   ],
10 |   "attributes": {
11 |     "lastModification": {
12 |       "actor": "eknorr",
13 |       "timestamp": "2024-02-23T01:00:40Z"
14 |     },
15 |     "lastModificationSignature": "6415c8fb586f4021b711df6fbceb9a6e6b31d6f2a556d6c807dfeb1cdffab632"
16 |   }
17 | }


--------------------------------------------------------------------------------
/tests/cases/PreferredStyle/thumbnail.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ia-eknorr/ignition-lint/0a9e66a089e76d6a50887ff6a6b735706ececced/tests/cases/PreferredStyle/thumbnail.png


--------------------------------------------------------------------------------
/tests/cases/PreferredStyle/view.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "custom": {
 3 |     "customViewParam": "value"
 4 |   },
 5 |   "params": {
 6 |     "viewParam": "value"
 7 |   },
 8 |   "propConfig": {
 9 |     "custom.customViewParam": {
10 |       "persistent": true
11 |     },
12 |     "params.viewParam": {
13 |       "paramDirection": "input",
14 |       "persistent": true
15 |     }
16 |   },
17 |   "props": {},
18 |   "root": {
19 |     "children": [
20 |       {
21 |         "custom": {
22 |           "componentCustomParam": "value"
23 |         },
24 |         "meta": {
25 |           "name": "IconPascalCase"
26 |         },
27 |         "position": {
28 |           "basis": "30px"
29 |         },
30 |         "props": {
31 |           "path": "material/insert_emoticon"
32 |         },
33 |         "type": "ia.display.icon"
34 |       }
35 |     ],
36 |     "custom": {
37 |       "rootCustomParam": "value"
38 |     },
39 |     "meta": {
40 |       "name": "root"
41 |     },
42 |     "props": {
43 |       "direction": "column"
44 |     },
45 |     "type": "ia.container.flex"
46 |   }
47 | }


--------------------------------------------------------------------------------
/tests/cases/Title Case/resource.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "scope": "G",
 3 |   "version": 1,
 4 |   "restricted": false,
 5 |   "overridable": true,
 6 |   "files": [
 7 |     "view.json",
 8 |     "thumbnail.png"
 9 |   ],
10 |   "attributes": {
11 |     "lastModification": {
12 |       "actor": "eknorr",
13 |       "timestamp": "2024-02-23T00:56:35Z"
14 |     },
15 |     "lastModificationSignature": "1ec60db6bce918665164e7f83dcd273ed8098f7b2fb782a8d13ab375251b15a7"
16 |   }
17 | }


--------------------------------------------------------------------------------
/tests/cases/Title Case/thumbnail.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ia-eknorr/ignition-lint/0a9e66a089e76d6a50887ff6a6b735706ececced/tests/cases/Title Case/thumbnail.png


--------------------------------------------------------------------------------
/tests/cases/Title Case/view.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "propConfig": {
 3 |     "params.ViewParam": {
 4 |       "paramDirection": "input",
 5 |       "persistent": true
 6 |     }
 7 |   },
 8 |   "props": {},
 9 |   "root": {
10 |     "children": [
11 |       {
12 |         "meta": {
13 |           "name": "Icon Title Case"
14 |         },
15 |         "position": {
16 |           "basis": "30px"
17 |         },
18 |         "props": {
19 |           "path": "material/insert_emoticon"
20 |         },
21 |         "type": "ia.display.icon"
22 |       }
23 |     ],
24 |     "meta": {
25 |       "name": "root"
26 |     },
27 |     "props": {
28 |       "direction": "column"
29 |     },
30 |     "type": "ia.container.flex"
31 |   }
32 | }


--------------------------------------------------------------------------------
/tests/cases/UPPER_CASE/resource.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "scope": "G",
 3 |   "version": 1,
 4 |   "restricted": false,
 5 |   "overridable": true,
 6 |   "files": [
 7 |     "view.json",
 8 |     "thumbnail.png"
 9 |   ],
10 |   "attributes": {
11 |     "lastModification": {
12 |       "actor": "eknorr",
13 |       "timestamp": "2024-02-23T01:08:20Z"
14 |     },
15 |     "lastModificationSignature": "c4af65749c49c08c43bf437736b797a5e0f7ab6edb744ff867ebf1292b535a2e"
16 |   }
17 | }


--------------------------------------------------------------------------------
/tests/cases/UPPER_CASE/thumbnail.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ia-eknorr/ignition-lint/0a9e66a089e76d6a50887ff6a6b735706ececced/tests/cases/UPPER_CASE/thumbnail.png


--------------------------------------------------------------------------------
/tests/cases/UPPER_CASE/view.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "custom": {
 3 |     "CUSTOM_VIEW_PARAM": "value"
 4 |   },
 5 |   "params": {
 6 |     "VIEW_PARAM": "value"
 7 |   },
 8 |   "propConfig": {
 9 |     "custom.CUSTOM_VIEW_PARAM": {
10 |       "persistent": true
11 |     },
12 |     "params.VIEW_PARAM": {
13 |       "paramDirection": "input",
14 |       "persistent": true
15 |     }
16 |   },
17 |   "props": {},
18 |   "root": {
19 |     "children": [
20 |       {
21 |         "custom": {
22 |           "COMPONENT_CUSTOM_PARAM": "value"
23 |         },
24 |         "meta": {
25 |           "name": "ICON_UPPER_CASE"
26 |         },
27 |         "position": {
28 |           "basis": "30px"
29 |         },
30 |         "props": {
31 |           "path": "material/insert_emoticon"
32 |         },
33 |         "type": "ia.display.icon"
34 |       }
35 |     ],
36 |     "custom": {
37 |       "ROOT_CUSTOM_PARAM": "value"
38 |     },
39 |     "meta": {
40 |       "name": "root"
41 |     },
42 |     "props": {
43 |       "direction": "column"
44 |     },
45 |     "type": "ia.container.flex"
46 |   }
47 | }


--------------------------------------------------------------------------------
/tests/cases/camelCase/resource.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "scope": "G",
 3 |   "version": 1,
 4 |   "restricted": false,
 5 |   "overridable": true,
 6 |   "files": [
 7 |     "view.json",
 8 |     "thumbnail.png"
 9 |   ],
10 |   "attributes": {
11 |     "lastModification": {
12 |       "actor": "eknorr",
13 |       "timestamp": "2024-02-23T00:53:38Z"
14 |     },
15 |     "lastModificationSignature": "c726198ce4cb0df3858577c6aff1b4c3abef1db9cebd190cbd37665d63c1ec60"
16 |   }
17 | }


--------------------------------------------------------------------------------
/tests/cases/camelCase/thumbnail.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ia-eknorr/ignition-lint/0a9e66a089e76d6a50887ff6a6b735706ececced/tests/cases/camelCase/thumbnail.png


--------------------------------------------------------------------------------
/tests/cases/camelCase/view.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "custom": {
 3 |     "customViewParam": "value"
 4 |   },
 5 |   "params": {
 6 |     "viewParam": "value"
 7 |   },
 8 |   "propConfig": {
 9 |     "custom.customViewParam": {
10 |       "persistent": true
11 |     },
12 |     "params.viewParam": {
13 |       "paramDirection": "input",
14 |       "persistent": true
15 |     }
16 |   },
17 |   "props": {},
18 |   "root": {
19 |     "children": [
20 |       {
21 |         "custom": {
22 |           "componentCustomParam": "value"
23 |         },
24 |         "meta": {
25 |           "name": "iconCamelCase"
26 |         },
27 |         "position": {
28 |           "basis": "30px"
29 |         },
30 |         "props": {
31 |           "path": "material/insert_emoticon"
32 |         },
33 |         "type": "ia.display.icon"
34 |       }
35 |     ],
36 |     "custom": {
37 |       "rootCustomParam": "value"
38 |     },
39 |     "meta": {
40 |       "name": "root"
41 |     },
42 |     "props": {
43 |       "direction": "column"
44 |     },
45 |     "type": "ia.container.flex"
46 |   }
47 | }


--------------------------------------------------------------------------------
/tests/cases/inconsistentCase/view.json:
--------------------------------------------------------------------------------
  1 | {
  2 |   "custom": {
  3 |     "PrettyBigIssue": "nope1",
  4 |     "THISIsQuestionable": "nope2",
  5 |     "TRYAGAIN": "nope3",
  6 |     "goodKey": {
  7 |       "EmbeddedNope": "still no"
  8 |     },
  9 |     "this_is_illegal": "nope4"
 10 |   },
 11 |   "params": {
 12 |     "VeryBadPractice": "value"
 13 |   },
 14 |   "propConfig": {
 15 |     "custom.PrettyBigIssue": {
 16 |       "persistent": true
 17 |     },
 18 |     "custom.THISIsQuestionable": {
 19 |       "persistent": true
 20 |     },
 21 |     "custom.TRYAGAIN": {
 22 |       "persistent": true
 23 |     },
 24 |     "custom.goodKey": {
 25 |       "persistent": true
 26 |     },
 27 |     "custom.this_is_illegal": {
 28 |       "persistent": true
 29 |     },
 30 |     "params.VeryBadPractice": {
 31 |       "paramDirection": "input",
 32 |       "persistent": true
 33 |     }
 34 |   },
 35 |   "props": {},
 36 |   "root": {
 37 |     "children": [
 38 |       {
 39 |         "custom": {
 40 |           "BadLabelCustomProp": "Oops",
 41 |           "key": "value",
 42 |           "labelCustomProperty": "hi",
 43 |           "sneakyBad": {
 44 |             "HaHaHaHaHa": "asdf"
 45 |           }
 46 |         },
 47 |         "meta": {
 48 |           "name": "GoodLabelName"
 49 |         },
 50 |         "position": {
 51 |           "basis": "32px"
 52 |         },
 53 |         "props": {
 54 |           "text": "Bad Label"
 55 |         },
 56 |         "type": "ia.display.label"
 57 |       },
 58 |       {
 59 |         "children": [
 60 |           {
 61 |             "custom": {
 62 |               "key": "value",
 63 |               "notSoBad": "value"
 64 |             },
 65 |             "meta": {
 66 |               "name": "EmbeddedPotato"
 67 |             },
 68 |             "position": {
 69 |               "grow": 1
 70 |             },
 71 |             "props": {
 72 |               "params": {
 73 |                 "BadStillDontCheck": "value",
 74 |                 "dontCheckMeGood": "value"
 75 |               },
 76 |               "path": "Exchange/MikesPotato"
 77 |             },
 78 |             "type": "ia.display.view"
 79 |           },
 80 |           {
 81 |             "custom": {
 82 |               "VeryVeryBadProperty": "value"
 83 |             },
 84 |             "meta": {
 85 |               "name": "badEmbeddedPotato_0"
 86 |             },
 87 |             "position": {
 88 |               "basis": "320px"
 89 |             },
 90 |             "props": {
 91 |               "params": {
 92 |                 "BadStillDontCheck": "value",
 93 |                 "dontCheckMeGood": "value"
 94 |               },
 95 |               "path": "Exchange/MikesPotato"
 96 |             },
 97 |             "type": "ia.display.view"
 98 |           }
 99 |         ],
100 |         "meta": {
101 |           "name": "FlexContainer"
102 |         },
103 |         "position": {
104 |           "basis": "320px"
105 |         },
106 |         "type": "ia.container.flex"
107 |       },
108 |       {
109 |         "custom": {
110 |           "VeryVeryBadProperty": "value"
111 |         },
112 |         "meta": {
113 |           "name": "bad potato"
114 |         },
115 |         "position": {
116 |           "basis": "320px"
117 |         },
118 |         "props": {
119 |           "params": {
120 |             "BadStillDontCheck": "value",
121 |             "dontCheckMeGood": "value"
122 |           },
123 |           "path": "Exchange/MikesPotato"
124 |         },
125 |         "type": "ia.display.view"
126 |       },
127 |       {
128 |         "custom": {
129 |           "VeryVeryBadProperty": "value"
130 |         },
131 |         "meta": {
132 |           "name": "anotherBadPotato"
133 |         },
134 |         "position": {
135 |           "basis": "320px"
136 |         },
137 |         "props": {
138 |           "params": {
139 |             "BadStillDontCheck": "value",
140 |             "dontCheckMeGood": "value"
141 |           },
142 |           "path": "Exchange/MikesPotato"
143 |         },
144 |         "type": "ia.display.view"
145 |       }
146 |     ],
147 |     "meta": {
148 |       "name": "root"
149 |     },
150 |     "props": {
151 |       "direction": "column"
152 |     },
153 |     "type": "ia.container.flex"
154 |   }
155 | }


--------------------------------------------------------------------------------
/tests/cases/kebab-case/resource.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "scope": "G",
 3 |   "version": 1,
 4 |   "restricted": false,
 5 |   "overridable": true,
 6 |   "files": [
 7 |     "view.json",
 8 |     "thumbnail.png"
 9 |   ],
10 |   "attributes": {
11 |     "lastModification": {
12 |       "actor": "eknorr",
13 |       "timestamp": "2024-02-23T00:52:21Z"
14 |     },
15 |     "lastModificationSignature": "bb21fe2f3b8ae77129c252fd99182e1d439482c574d99cc30dd6d632571bd245"
16 |   }
17 | }


--------------------------------------------------------------------------------
/tests/cases/kebab-case/thumbnail.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ia-eknorr/ignition-lint/0a9e66a089e76d6a50887ff6a6b735706ececced/tests/cases/kebab-case/thumbnail.png


--------------------------------------------------------------------------------
/tests/cases/kebab-case/view.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "custom": {
 3 |     "custom-view-param": "value"
 4 |   },
 5 |   "params": {
 6 |     "view-param": "value"
 7 |   },
 8 |   "propConfig": {
 9 |     "custom.custom-view-param": {
10 |       "persistent": true
11 |     },
12 |     "params.view-param": {
13 |       "paramDirection": "input",
14 |       "persistent": true
15 |     }
16 |   },
17 |   "props": {},
18 |   "root": {
19 |     "children": [
20 |       {
21 |         "custom": {
22 |           "component-custom-param": "value"
23 |         },
24 |         "meta": {
25 |           "name": "icon-kebab-case"
26 |         },
27 |         "position": {
28 |           "basis": "30px"
29 |         },
30 |         "props": {
31 |           "path": "material/insert_emoticon"
32 |         },
33 |         "type": "ia.display.icon"
34 |       }
35 |     ],
36 |     "custom": {
37 |       "root-custom-param": "value"
38 |     },
39 |     "meta": {
40 |       "name": "root"
41 |     },
42 |     "props": {
43 |       "direction": "column"
44 |     },
45 |     "type": "ia.container.flex"
46 |   }
47 | }


--------------------------------------------------------------------------------
/tests/cases/snake_case/resource.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "scope": "G",
 3 |   "version": 1,
 4 |   "restricted": false,
 5 |   "overridable": true,
 6 |   "files": [
 7 |     "view.json",
 8 |     "thumbnail.png"
 9 |   ],
10 |   "attributes": {
11 |     "lastModification": {
12 |       "actor": "eknorr",
13 |       "timestamp": "2024-02-23T00:52:21Z"
14 |     },
15 |     "lastModificationSignature": "bb21fe2f3b8ae77129c252fd99182e1d439482c574d99cc30dd6d632571bd245"
16 |   }
17 | }


--------------------------------------------------------------------------------
/tests/cases/snake_case/thumbnail.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/ia-eknorr/ignition-lint/0a9e66a089e76d6a50887ff6a6b735706ececced/tests/cases/snake_case/thumbnail.png


--------------------------------------------------------------------------------
/tests/cases/snake_case/view.json:
--------------------------------------------------------------------------------
 1 | {
 2 |   "custom": {
 3 |     "custom_view_param": "value"
 4 |   },
 5 |   "params": {
 6 |     "view_param": "value"
 7 |   },
 8 |   "propConfig": {
 9 |     "custom.custom_view_param": {
10 |       "persistent": true
11 |     },
12 |     "params.view_param": {
13 |       "paramDirection": "input",
14 |       "persistent": true
15 |     }
16 |   },
17 |   "props": {},
18 |   "root": {
19 |     "children": [
20 |       {
21 |         "custom": {
22 |           "component_custom_param": "value"
23 |         },
24 |         "meta": {
25 |           "name": "icon_snake_case"
26 |         },
27 |         "position": {
28 |           "basis": "30px"
29 |         },
30 |         "props": {
31 |           "path": "material/insert_emoticon"
32 |         },
33 |         "type": "ia.display.icon"
34 |       }
35 |     ],
36 |     "custom": {
37 |       "root_custom_param": "value"
38 |     },
39 |     "meta": {
40 |       "name": "root"
41 |     },
42 |     "props": {
43 |       "direction": "column"
44 |     },
45 |     "type": "ia.container.flex"
46 |   }
47 | }


--------------------------------------------------------------------------------
/tests/test_checker.py:
--------------------------------------------------------------------------------
  1 | """Tests for the StyleChecker class."""
  2 | import unittest
  3 | import sys
  4 | import os
  5 | 
  6 | # Add the src directory to the PYTHONPATH
  7 | sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '../src')))
  8 | 
  9 | from checker import StyleChecker # pylint: disable=wrong-import-position
 10 | 
 11 | class StyleCheckerTests(unittest.TestCase):
 12 |     """Tests for the StyleChecker class."""
 13 | 
 14 |     def test_is_snake_case(self):
 15 |         """Test the is_snake_case method."""
 16 |         checker = StyleChecker("snake_case")
 17 |         self.assertTrue(checker.is_correct_style("my_variable"))
 18 |         self.assertFalse(checker.is_correct_style("MyVariable"))
 19 |         self.assertFalse(checker.is_correct_style("myVariable"))
 20 |         self.assertFalse(checker.is_correct_style("MY_VARIABLE"))
 21 |         self.assertTrue(checker.is_correct_style("my_variable_123"))
 22 |         self.assertFalse(checker.is_correct_style("MyVariable123"))
 23 |         self.assertFalse(checker.is_correct_style("myVariable123"))
 24 |         self.assertFalse(checker.is_correct_style("MY_VARIABLE_123"))
 25 | 
 26 |     def test_is_camel_case(self):
 27 |         """Test the is_camel_case method."""
 28 |         checker = StyleChecker("camelCase")
 29 |         self.assertFalse(checker.is_correct_style("my_variable"))
 30 |         self.assertTrue(checker.is_correct_style("myVariable"))
 31 |         self.assertFalse(checker.is_correct_style("MyVariable"))
 32 |         self.assertFalse(checker.is_correct_style("MY_VARIABLE"))
 33 |         self.assertFalse(checker.is_correct_style("my_variable_123"))
 34 |         self.assertFalse(checker.is_correct_style("MyVariable123"))
 35 |         self.assertTrue(checker.is_correct_style("myVariable123"))
 36 |         self.assertFalse(checker.is_correct_style("MY_VARIABLE_123"))
 37 | 
 38 |     def test_is_pascal_case(self):
 39 |         """Test the is_pascal_case method."""
 40 |         checker = StyleChecker("PascalCase")
 41 |         self.assertFalse(checker.is_correct_style("my_variable"))
 42 |         self.assertFalse(checker.is_correct_style("myVariable"))
 43 |         self.assertTrue(checker.is_correct_style("MyVariable"))
 44 |         self.assertFalse(checker.is_correct_style("MY_VARIABLE"))
 45 |         self.assertFalse(checker.is_correct_style("my_variable_123"))
 46 |         self.assertTrue(checker.is_correct_style("MyVariable123"))
 47 |         self.assertFalse(checker.is_correct_style("myVariable123"))
 48 |         self.assertFalse(checker.is_correct_style("MY_VARIABLE_123"))
 49 | 
 50 |     def test_is_upper_case(self):
 51 |         """Test the is_upper_case method."""
 52 |         checker = StyleChecker("UPPER_CASE")
 53 |         self.assertFalse(checker.is_correct_style("my_variable"))
 54 |         self.assertFalse(checker.is_correct_style("myVariable"))
 55 |         self.assertFalse(checker.is_correct_style("MyVariable"))
 56 |         self.assertTrue(checker.is_correct_style("MY_VARIABLE"))
 57 |         self.assertFalse(checker.is_correct_style("my_variable_123"))
 58 |         self.assertFalse(checker.is_correct_style("MyVariable123"))
 59 |         self.assertFalse(checker.is_correct_style("myVariable123"))
 60 |         self.assertTrue(checker.is_correct_style("MY_VARIABLE_123"))
 61 | 
 62 |     def test_is_any(self):
 63 |         """Test the is_any method."""
 64 |         checker = StyleChecker("any")
 65 |         self.assertTrue(checker.is_correct_style("my_variable"))
 66 |         self.assertTrue(checker.is_correct_style("myVariable"))
 67 |         self.assertTrue(checker.is_correct_style("MyVariable"))
 68 |         self.assertTrue(checker.is_correct_style("MY_VARIABLE"))
 69 |         self.assertTrue(checker.is_correct_style("my_variable_123"))
 70 |         self.assertTrue(checker.is_correct_style("MyVariable123"))
 71 |         self.assertTrue(checker.is_correct_style("myVariable123"))
 72 |         self.assertTrue(checker.is_correct_style("MY_VARIABLE_123"))
 73 | 
 74 |     def test_is_camel_case_with_acronyms(self):
 75 |         """Test the is_camel_case method with acronyms allowed."""
 76 |         checker = StyleChecker("camelCase", True)
 77 |         self.assertFalse(checker.is_correct_style("my_variable"))
 78 |         self.assertTrue(checker.is_correct_style("myVariable"))
 79 |         self.assertFalse(checker.is_correct_style("MyVariable"))
 80 |         self.assertFalse(checker.is_correct_style("MY_VARIABLE"))
 81 |         self.assertFalse(checker.is_correct_style("my_variable_123"))
 82 |         self.assertFalse(checker.is_correct_style("MyVariable123"))
 83 |         self.assertTrue(checker.is_correct_style("myVariable123"))
 84 |         self.assertFalse(checker.is_correct_style("MY_VARIABLE_123"))
 85 |         self.assertTrue(checker.is_correct_style("myVAR1"))
 86 |         self.assertTrue(checker.is_correct_style("VAR1"))
 87 |         self.assertTrue(checker.is_correct_style("variable"))
 88 |         self.assertTrue(checker.is_correct_style("USPopulation"))
 89 |         self.assertTrue(checker.is_correct_style("myVAR"))
 90 |         self.assertTrue(checker.is_correct_style("myVAR1a"))
 91 |         self.assertTrue(checker.is_correct_style("VAR1A"))
 92 | 
 93 |     def test_is_pascal_case_with_acronyms(self):
 94 |         """Test the is_pascal_case method with acronyms allowed."""
 95 |         checker = StyleChecker("PascalCase", True)
 96 |         self.assertFalse(checker.is_correct_style("my_variable"))
 97 |         self.assertFalse(checker.is_correct_style("myVariable"))
 98 |         self.assertTrue(checker.is_correct_style("MyVariable"))
 99 |         self.assertFalse(checker.is_correct_style("MY_VARIABLE"))
100 |         self.assertFalse(checker.is_correct_style("my_variable_123"))
101 |         self.assertTrue(checker.is_correct_style("MyVariable123"))
102 |         self.assertFalse(checker.is_correct_style("myVariable123"))
103 |         self.assertFalse(checker.is_correct_style("MY_VARIABLE_123"))
104 |         self.assertFalse(checker.is_correct_style("myVAR1"))
105 |         self.assertTrue(checker.is_correct_style("VAR1"))
106 |         self.assertTrue(checker.is_correct_style("Variable"))
107 |         self.assertTrue(checker.is_correct_style("USPopulation"))
108 |         self.assertTrue(checker.is_correct_style("MyVAR"))
109 |         self.assertFalse(checker.is_correct_style("MyVAR1a"))
110 |         self.assertTrue(checker.is_correct_style("VAR1A"))
111 | 
112 |     def test_is_title_case_with_acronyms(self):
113 |         """Test the is_title_case method with acronyms allowed."""
114 |         checker = StyleChecker("Title Case", True)
115 |         self.assertFalse(checker.is_correct_style("my_variable"))
116 |         self.assertFalse(checker.is_correct_style("myVariable"))
117 |         self.assertFalse(checker.is_correct_style("MyVariable"))
118 |         self.assertFalse(checker.is_correct_style("MY_VARIABLE"))
119 |         self.assertFalse(checker.is_correct_style("my_variable_123"))
120 |         self.assertFalse(checker.is_correct_style("MyVariable123"))
121 |         self.assertFalse(checker.is_correct_style("myVariable123"))
122 |         self.assertFalse(checker.is_correct_style("MY_VARIABLE_123"))
123 |         self.assertFalse(checker.is_correct_style("myVAR1"))
124 |         self.assertFalse(checker.is_correct_style("VAR1"))
125 |         self.assertTrue(checker.is_correct_style("Variable"))
126 |         self.assertFalse(checker.is_correct_style("USPopulation"))
127 |         self.assertFalse(checker.is_correct_style("MyVAR"))
128 |         self.assertFalse(checker.is_correct_style("MyVAR1a"))
129 |         self.assertFalse(checker.is_correct_style("VAR1A"))
130 |         self.assertTrue(checker.is_correct_style("US Population"))
131 |         self.assertTrue(checker.is_correct_style("My Variable"))
132 |         self.assertTrue(checker.is_correct_style("My Var 1"))
133 |         self.assertTrue(checker.is_correct_style("Var 1A"))
134 |         self.assertTrue(checker.is_correct_style("My Variable But Longer"))
135 | 
136 | 
137 | if __name__ == "__main__":
138 |     unittest.main()
139 | 


--------------------------------------------------------------------------------
/tests/test_ignition_lint.py:
--------------------------------------------------------------------------------
  1 | """ This module contains the tests for the Ignition Lint tool. """
  2 | 
  3 | import unittest
  4 | import os
  5 | import sys
  6 | from unittest.mock import patch
  7 | from io import StringIO
  8 | 
  9 | # Add the src directory to the PYTHONPATH
 10 | sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "../src")))
 11 | 
 12 | import ignition_lint  # pylint: disable=wrong-import-position, import-error
 13 | 
 14 | 
 15 | class JsonLinterTests(unittest.TestCase):
 16 |     """Tests for the JsonLinter class."""
 17 | 
 18 |     def setUp(self):
 19 |         self.linter = ignition_lint.JsonLinter(
 20 |             "PascalCase", "camelCase", None, None, False
 21 |         )
 22 | 
 23 |     def test_lint_file_with_valid_json(self):
 24 |         """Test the lint_file method with a valid JSON file."""
 25 |         file_path = "./tests/cases/PreferredStyle/view.json"
 26 |         expected_errors = {"components": [], "parameters": []}
 27 | 
 28 |         with patch("builtins.open", create=True) as mock_open:
 29 |             mock_file = mock_open.return_value.__enter__.return_value
 30 |             mock_file.read.return_value = '{"key": "value"}'
 31 |             mock_file.__exit__.return_value = None
 32 | 
 33 |             lint_errors = self.linter.lint_file(file_path)
 34 | 
 35 |             mock_open.assert_called_once_with(file_path, "r", encoding="utf-8")
 36 |             mock_file.read.assert_called_once()
 37 |             self.assertEqual(lint_errors, 0)
 38 |             self.assertEqual(self.linter.errors, expected_errors)
 39 | 
 40 |     def test_lint_file_with_invalid_json(self):
 41 |         """Test the lint_file method with an invalid JSON file."""
 42 |         file_path = "./nonexistent/test/view.json"
 43 |         expected_errors = 0
 44 | 
 45 |         with patch("builtins.open", create=True) as mock_open:
 46 |             mock_file = mock_open.return_value.__enter__.return_value
 47 |             mock_file.read.return_value = '{"key": "value}'
 48 |             mock_file.__exit__.return_value = None
 49 | 
 50 |             errors = self.linter.lint_file(file_path)
 51 | 
 52 |             self.assertEqual(errors, expected_errors)
 53 | 
 54 |     def test_check_component_names_with_valid_component_names(self):
 55 |         """Test the check_component_names method with valid component names."""
 56 |         data = {
 57 |             "meta": {"name": "root"},
 58 |             "children": {
 59 |                 "meta": {"ValidName": "value"},
 60 |                 "props": {"params": {"param1": "value1", "param2": "value2"}},
 61 |             },
 62 |         }
 63 |         expected_errors = {"components": [], "parameters": []}
 64 | 
 65 |         self.linter.check_component_names(data, self.linter.errors)
 66 | 
 67 |         self.assertEqual(self.linter.errors, expected_errors)
 68 | 
 69 |     def test_check_component_names_with_invalid_component_names(self):
 70 |         """Test the check_component_names method with invalid component names."""
 71 |         data = {
 72 |             "meta": {"name": "root"},
 73 |             "children": {
 74 |                 "meta": {"name": "invalidChildName1"},
 75 |                 "props": {"params": {"param1": "value1", "param2": "value2"}},
 76 |             },
 77 |         }
 78 |         expected_errors = {"components": ["root/invalidChildName1"], "parameters": []}
 79 | 
 80 |         self.linter.check_component_names(data, self.linter.errors)
 81 | 
 82 |         self.assertEqual(self.linter.errors, expected_errors)
 83 | 
 84 |     def test_check_parameter_names_with_valid_parameter_names(self):
 85 |         """Test the check_parameter_names method with valid parameter names."""
 86 |         data = {"param1": "value1", "param2": "value2"}
 87 |         expected_errors = {"components": [], "parameters": []}
 88 | 
 89 |         self.linter.check_parameter_names(data, self.linter.errors)
 90 | 
 91 |         self.assertEqual(self.linter.errors, expected_errors)
 92 | 
 93 |     def test_check_parameter_names_with_invalid_parameter_names(self):
 94 |         """Test the check_parameter_names method with invalid parameter names."""
 95 |         data = {"Param1": "value1", "Param2": "value2"}
 96 |         expected_errors = {"components": [], "parameters": ["Param1", "Param2"]}
 97 | 
 98 |         self.linter.check_parameter_names(data, self.linter.errors)
 99 | 
100 |         self.assertEqual(self.linter.errors, expected_errors)
101 | 
102 |     def test_check_parameter_names_with_dataset(self):
103 |         """Test the check_parameter_names method with a dataset."""
104 |         data = {
105 |             "$": ["ds", 192, 1723242356734],
106 |             "$columns": [
107 |                 {
108 |                     "name": "City",
109 |                     "type": "String",
110 |                     "data": [
111 |                         "New York",
112 |                         "Los Angeles",
113 |                         "Chicago",
114 |                         "Houston",
115 |                         "Phoenix",
116 |                     ],
117 |                 },
118 |                 {
119 |                     "name": "Population",
120 |                     "type": "Integer",
121 |                     "data": [8363710, 3833995, 2853114, 2242193, 1567924],
122 |                 },
123 |                 {
124 |                     "name": "Timezone",
125 |                     "type": "String",
126 |                     "data": ["EST", "PST", "CST", "CST", "MST"],
127 |                 },
128 |                 {"name": "GMTOffset", "type": "Integer", "data": [-5, -8, -6, -6, -7]},
129 |             ],
130 |         }
131 | 
132 |         # Should skip the $ key, yielding no errors
133 |         expected_errors = {"components": [], "parameters": []}
134 | 
135 |         self.linter.check_parameter_names(data, self.linter.errors)
136 | 
137 |         self.assertEqual(self.linter.errors, expected_errors)
138 | 
139 |     def test_main_with_multiple_files(self):
140 |         """Test the main function with multiple files."""
141 |         file_paths = [
142 |             "./tests/cases/camelCase/view.json",
143 |             "./tests/cases/PascalCase/view.json",
144 |         ]
145 |         expected_errors = {
146 |             "./tests/cases/camelCase/view.json": [
147 |                 "- root/iconCamelCase",
148 |                 "- view.custom.customViewParam",
149 |                 "- view.params.viewParam",
150 |                 "- root/iconCamelCase.custom.componentCustomParam",
151 |                 "- root.custom.rootCustomParam",
152 |             ],
153 |             "./tests/cases/PascalCase/view.json": [],
154 |         }
155 |         with patch("sys.stdout", new_callable=StringIO) as mock_stdout:
156 |             with patch(
157 |                 "sys.argv",
158 |                 ["ignition_lint.py", "--files"]
159 |                 + [",".join(file_paths)]
160 |                 + [
161 |                     "--component-style",
162 |                     "PascalCase",
163 |                     "--parameter-style",
164 |                     "PascalCase",
165 |                 ],
166 |             ):
167 |                 try:
168 |                     ignition_lint.main()
169 |                 except SystemExit:
170 |                     pass
171 | 
172 |                 output = mock_stdout.getvalue().strip()
173 |                 lines = output.split("\n")
174 | 
175 |             errors_dict = {file_path: [] for file_path in file_paths}
176 | 
177 |             for line in lines:
178 |                 if line.startswith("Error in file: "):
179 |                     current_file_path = line.replace("Error in file: ", "").strip()
180 |                 elif line.strip().startswith("-"):
181 |                     errors_dict[current_file_path].append(line.strip())
182 | 
183 |             self.assertEqual(
184 |                 len(errors_dict[file_paths[0]]), len(expected_errors[file_paths[0]])
185 |             )
186 |             self.assertEqual(
187 |                 len(errors_dict[file_paths[1]]), len(expected_errors[file_paths[1]])
188 |             )
189 | 
190 |     def test_lint_file_with_glob_pattern(self):
191 |         """Test the lint_file method with a glob pattern."""
192 |         valid_file_path = "**/PreferredStyle/view.json"
193 |         invalid_file_path = "nonexistent/**/view.json"
194 | 
195 |         self.linter.lint_file(valid_file_path)
196 |         self.assertEqual(self.linter.files_linted, 1)
197 | 
198 |         self.linter.lint_file(invalid_file_path)
199 |         self.assertEqual(self.linter.files_linted, 1)
200 | 
201 | 
202 | if __name__ == "__main__":
203 |     unittest.main()
204 | 


--------------------------------------------------------------------------------