acumatica-lint 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for describing the origin of the Work and
141
+ reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Support. While redistributing the Work or
166
+ Derivative Works thereof, You may choose to offer, and charge a
167
+ fee for, acceptance of support, warranty, indemnity, or other
168
+ liability obligations and/or rights consistent with this License.
169
+ However, in accepting such obligations, You may act only on Your
170
+ own behalf and on Your sole responsibility, not on behalf of any
171
+ other Contributor, and only if You agree to indemnify, defend,
172
+ and hold each Contributor harmless for any liability incurred by,
173
+ or claims asserted against, such Contributor by reason of your
174
+ accepting any such warranty or support.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2026 Studio B AI
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,150 @@
1
+ Metadata-Version: 2.4
2
+ Name: acumatica-lint
3
+ Version: 0.1.0
4
+ Summary: Free, open-source linter for Acumatica customization projects. The full pipeline is AcuOps.
5
+ Author-email: Studio B <hello@studiob.ai>
6
+ License: Apache-2.0
7
+ Project-URL: Homepage, https://acuops.com
8
+ Project-URL: Repository, https://github.com/studio-b-ai/acumatica-lint
9
+ Project-URL: Issue tracker, https://github.com/studio-b-ai/acumatica-lint/issues
10
+ Project-URL: Full pipeline (AcuOps), https://acuops.com
11
+ Keywords: acumatica,linter,customization,validate,project.xml,static-analysis,devops
12
+ Classifier: Development Status :: 4 - Beta
13
+ Classifier: Environment :: Console
14
+ Classifier: Intended Audience :: Developers
15
+ Classifier: Intended Audience :: Information Technology
16
+ Classifier: License :: OSI Approved :: Apache Software License
17
+ Classifier: Operating System :: OS Independent
18
+ Classifier: Programming Language :: Python :: 3
19
+ Classifier: Programming Language :: Python :: 3.10
20
+ Classifier: Programming Language :: Python :: 3.11
21
+ Classifier: Programming Language :: Python :: 3.12
22
+ Classifier: Programming Language :: Python :: 3.13
23
+ Classifier: Topic :: Software Development :: Quality Assurance
24
+ Classifier: Topic :: Software Development :: Build Tools
25
+ Requires-Python: >=3.10
26
+ Description-Content-Type: text/markdown
27
+ License-File: LICENSE
28
+ Requires-Dist: pyyaml>=6.0
29
+ Provides-Extra: dev
30
+ Requires-Dist: pytest>=7.0; extra == "dev"
31
+ Requires-Dist: ruff>=0.5; extra == "dev"
32
+ Dynamic: license-file
33
+
34
+ # acumatica-lint
35
+
36
+ [![PyPI](https://img.shields.io/pypi/v/acumatica-lint.svg)](https://pypi.org/project/acumatica-lint/)
37
+ [![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
38
+ [![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
39
+
40
+ > Free, open-source linter for Acumatica customization projects. Catches publish-time failure modes — silent `NullReferenceException`s, dropped DAC extensions, orphan SiteMap rows, GI catalog exclusions, schema mutations without `IF NOT EXISTS` guards — before they restart your production app pool.
41
+ >
42
+ > Want this run automatically on every PR, plus sandbox dry-run before prod, snapshot/rollback with integrity verification, Codex AI review, Slack telemetry, and deploy-window enforcement? → **[AcuOps](https://acuops.com)**
43
+
44
+ ## Install
45
+
46
+ ```bash
47
+ pip install acumatica-lint
48
+ ```
49
+
50
+ Python 3.10+. One dependency (`pyyaml` for the ISV co-publish allowlist parser). Works on macOS, Linux, and Windows.
51
+
52
+ ## Use
53
+
54
+ Point it at a `project.xml`:
55
+
56
+ ```bash
57
+ acumatica-lint Customization/MyPackage/project.xml
58
+ ```
59
+
60
+ With strict mode (additional warnings for best-practice violations):
61
+
62
+ ```bash
63
+ acumatica-lint --strict Customization/MyPackage/project.xml
64
+ ```
65
+
66
+ ISV authors — enforce a class-name prefix on all `<Graph>` declarations:
67
+
68
+ ```bash
69
+ acumatica-lint --isv-prefix AO Customization/MyISV/project.xml
70
+ ```
71
+
72
+ Debug-only DLL-source plugin scan (skips XML/Graph/semantic checks):
73
+
74
+ ```bash
75
+ acumatica-lint --dll-source-only Customization/MyPackage/project.xml
76
+ ```
77
+
78
+ ### Exit codes
79
+
80
+ - `0` — passed (with or without warnings)
81
+ - `1` — failed (one or more hard-fail errors)
82
+ - `2` — usage error (bad CLI args)
83
+
84
+ ## What it catches
85
+
86
+ `acumatica-lint` encodes ~60 failure-mode rules from real Acumatica production incidents Studio B has resolved. A non-exhaustive list:
87
+
88
+ - **DAC fields without matching `<Sql>` ALTER TABLE** — auto-column creation has been broken on cloud Acumatica since early 2026. `[PXDBx]` fields without a corresponding `<Sql>` ALTER will silently fail at publish.
89
+ - **Phantom DAC references in `<GITable Name>`** — silently aborts GI processing without an error in the publish log.
90
+ - **GI Creation Contract** — every new OData-exposed GI requires `<RolesInGraph Rolename="*" Accessrights="4" ApplicationName="/" />` AND a matching entry in the package's `CustomizationPlugin` allowlist. Miss either and the GI silently catalog-excludes, returning HTTP 404 from `/OData/{tenant}/$metadata`.
91
+ - **SiteMap orphans** (`ParentID="00000000-..."`) — invisible in `SM205010 (Access Rights by Role)`, ungrantable, OData 404.
92
+ - **Modern GI format requirements** (24.208+) — `GITable.Name` must be fully-qualified DAC name; `<GIWhere Condition>` must use Acumatica's vocabulary (`"E "`, `"NE"`, `"GE"`, etc., NOT `"EQ"`); `<GIWhere>` attribute name is `Operation=` NOT `Operator=`; `MUIScreen.SubcategoryID` must point at tenant-real subcategory, not auto-created system-default.
93
+ - **`<Sql>` re-execution warnings** — `<Sql>` scripts are tracked by Name; bumping to `_v2` is silently skipped. For logic that must survive every publish, use `CustomizationPlugin.PXDatabase.Execute()`.
94
+ - **DAC extension fields without `<EntityEndpoint>` mapping** — `PUT` returns HTTP 200 + echoes value + silent-drops at commit. Three places must match: SQL column, DAC attribute, inline `<EntityEndpoint>` block.
95
+ - **C# CustomizationPlugin static checks** — banned APIs (`WebConfigurationManager`, `HttpContext`); SQL against GI* tables in `UpdateDatabase()`; SQL against `INUnit`; INSERT/UPDATE/SELECT column refs on Acumatica system tables outside the allowlist.
96
+ - **DLL source reference auditing** — gap-closer for compiled-DLL plugins: every plugin check runs on every `.cs` under `src/<DllName>/` when `project.xml` references `<File AppRelativePath="Bin\<DllName>.dll" />`.
97
+ - **ISV prefix enforcement** — when invoked with `--isv-prefix`, validates that every `<Graph ClassName=>` follows your ISV convention.
98
+ - **Inline `<EntityEndpoint>` block requirements** — must be a top-level child of `<Customization>` in `project.xml`; standalone `EntityEndpoint_*.xml` at zip root is NOT processed.
99
+
100
+ Every hard-fail check ships an escape-hatch comment marker for audited exceptions:
101
+
102
+ ```xml
103
+ <!-- REVIEWED: gi-sql-safe — suppress validate_gi_sql -->
104
+ <!-- REVIEWED: inunit-sql-safe — suppress validate_inunit_sql -->
105
+ <!-- REVIEWED: schema-safe — suppress validate_plugin_sql_column_refs -->
106
+ ```
107
+
108
+ ## What this linter is NOT
109
+
110
+ This linter is the deterministic check engine. It runs once, against one project, returns errors and warnings, exits.
111
+
112
+ It does **not**:
113
+
114
+ - Run continuously on every PR
115
+ - Push your customization to a sandbox tenant and run an end-to-end test suite before allowing the prod publish
116
+ - Take a snapshot of your current customization state with integrity verification before each publish (catching `merge=true` partial-publish corruption)
117
+ - Roll back automatically when a publish fails midway
118
+ - Review the C# code in `CustomizationPlugin.UpdateDatabase()` with AI to flag non-obvious correctness issues a static rule can't catch
119
+ - Post `:rotating_light:` Slack notifications when a publish fails
120
+ - Enforce deploy windows (no schema changes during business hours)
121
+ - Coordinate co-publishes with ISV packages without inflating the `publishBegin` page count past Acumatica's `ThreadAbortException` limit
122
+ - Issue + revoke per-VAR license keys with grace periods
123
+
124
+ All of that is **[AcuOps](https://acuops.com)** — the managed pipeline. $800/mo per Acumatica instance.
125
+
126
+ ## Founding partners
127
+
128
+ AcuOps is selecting 7–10 founding partners locked at **$500/mo for the life of subscription** in exchange for a published case study + reference availability. We're picking partners across VAR, ISV, in-house mid-market, and enterprise deployment patterns. → [Apply](https://acuops.com/founding-partners)
129
+
130
+ ## Contributing
131
+
132
+ Pull requests welcome. New rules should:
133
+
134
+ 1. Reference the originating production incident (AAR date, PR number, or both) in a comment
135
+ 2. Ship with both a positive example (`project.xml` snippet that triggers the rule) and a negative example
136
+ 3. Include an escape-hatch comment marker if the rule may have legitimate exceptions
137
+
138
+ Coding style is enforced by `ruff`. Run `pip install -e ".[dev]"` then `ruff check src/`.
139
+
140
+ ## License
141
+
142
+ Apache 2.0 — see [LICENSE](./LICENSE).
143
+
144
+ The Apache 2.0 patent grant protects all contributors from patent litigation over contributed code. This matters when the codebase encodes hard-won failure-mode knowledge from real production incidents.
145
+
146
+ ## Built by Studio B
147
+
148
+ Studio B ([studiob.ai](https://studiob.ai)) runs Acumatica deployments at scale across its portfolio. `acumatica-lint` is the static-check engine extracted from the AcuOps pipeline — the same code paths Studio B uses against its own production deployments.
149
+
150
+ The full pipeline → [acuops.com](https://acuops.com)
@@ -0,0 +1,117 @@
1
+ # acumatica-lint
2
+
3
+ [![PyPI](https://img.shields.io/pypi/v/acumatica-lint.svg)](https://pypi.org/project/acumatica-lint/)
4
+ [![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
5
+ [![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
6
+
7
+ > Free, open-source linter for Acumatica customization projects. Catches publish-time failure modes — silent `NullReferenceException`s, dropped DAC extensions, orphan SiteMap rows, GI catalog exclusions, schema mutations without `IF NOT EXISTS` guards — before they restart your production app pool.
8
+ >
9
+ > Want this run automatically on every PR, plus sandbox dry-run before prod, snapshot/rollback with integrity verification, Codex AI review, Slack telemetry, and deploy-window enforcement? → **[AcuOps](https://acuops.com)**
10
+
11
+ ## Install
12
+
13
+ ```bash
14
+ pip install acumatica-lint
15
+ ```
16
+
17
+ Python 3.10+. One dependency (`pyyaml` for the ISV co-publish allowlist parser). Works on macOS, Linux, and Windows.
18
+
19
+ ## Use
20
+
21
+ Point it at a `project.xml`:
22
+
23
+ ```bash
24
+ acumatica-lint Customization/MyPackage/project.xml
25
+ ```
26
+
27
+ With strict mode (additional warnings for best-practice violations):
28
+
29
+ ```bash
30
+ acumatica-lint --strict Customization/MyPackage/project.xml
31
+ ```
32
+
33
+ ISV authors — enforce a class-name prefix on all `<Graph>` declarations:
34
+
35
+ ```bash
36
+ acumatica-lint --isv-prefix AO Customization/MyISV/project.xml
37
+ ```
38
+
39
+ Debug-only DLL-source plugin scan (skips XML/Graph/semantic checks):
40
+
41
+ ```bash
42
+ acumatica-lint --dll-source-only Customization/MyPackage/project.xml
43
+ ```
44
+
45
+ ### Exit codes
46
+
47
+ - `0` — passed (with or without warnings)
48
+ - `1` — failed (one or more hard-fail errors)
49
+ - `2` — usage error (bad CLI args)
50
+
51
+ ## What it catches
52
+
53
+ `acumatica-lint` encodes ~60 failure-mode rules from real Acumatica production incidents Studio B has resolved. A non-exhaustive list:
54
+
55
+ - **DAC fields without matching `<Sql>` ALTER TABLE** — auto-column creation has been broken on cloud Acumatica since early 2026. `[PXDBx]` fields without a corresponding `<Sql>` ALTER will silently fail at publish.
56
+ - **Phantom DAC references in `<GITable Name>`** — silently aborts GI processing without an error in the publish log.
57
+ - **GI Creation Contract** — every new OData-exposed GI requires `<RolesInGraph Rolename="*" Accessrights="4" ApplicationName="/" />` AND a matching entry in the package's `CustomizationPlugin` allowlist. Miss either and the GI silently catalog-excludes, returning HTTP 404 from `/OData/{tenant}/$metadata`.
58
+ - **SiteMap orphans** (`ParentID="00000000-..."`) — invisible in `SM205010 (Access Rights by Role)`, ungrantable, OData 404.
59
+ - **Modern GI format requirements** (24.208+) — `GITable.Name` must be fully-qualified DAC name; `<GIWhere Condition>` must use Acumatica's vocabulary (`"E "`, `"NE"`, `"GE"`, etc., NOT `"EQ"`); `<GIWhere>` attribute name is `Operation=` NOT `Operator=`; `MUIScreen.SubcategoryID` must point at tenant-real subcategory, not auto-created system-default.
60
+ - **`<Sql>` re-execution warnings** — `<Sql>` scripts are tracked by Name; bumping to `_v2` is silently skipped. For logic that must survive every publish, use `CustomizationPlugin.PXDatabase.Execute()`.
61
+ - **DAC extension fields without `<EntityEndpoint>` mapping** — `PUT` returns HTTP 200 + echoes value + silent-drops at commit. Three places must match: SQL column, DAC attribute, inline `<EntityEndpoint>` block.
62
+ - **C# CustomizationPlugin static checks** — banned APIs (`WebConfigurationManager`, `HttpContext`); SQL against GI* tables in `UpdateDatabase()`; SQL against `INUnit`; INSERT/UPDATE/SELECT column refs on Acumatica system tables outside the allowlist.
63
+ - **DLL source reference auditing** — gap-closer for compiled-DLL plugins: every plugin check runs on every `.cs` under `src/<DllName>/` when `project.xml` references `<File AppRelativePath="Bin\<DllName>.dll" />`.
64
+ - **ISV prefix enforcement** — when invoked with `--isv-prefix`, validates that every `<Graph ClassName=>` follows your ISV convention.
65
+ - **Inline `<EntityEndpoint>` block requirements** — must be a top-level child of `<Customization>` in `project.xml`; standalone `EntityEndpoint_*.xml` at zip root is NOT processed.
66
+
67
+ Every hard-fail check ships an escape-hatch comment marker for audited exceptions:
68
+
69
+ ```xml
70
+ <!-- REVIEWED: gi-sql-safe — suppress validate_gi_sql -->
71
+ <!-- REVIEWED: inunit-sql-safe — suppress validate_inunit_sql -->
72
+ <!-- REVIEWED: schema-safe — suppress validate_plugin_sql_column_refs -->
73
+ ```
74
+
75
+ ## What this linter is NOT
76
+
77
+ This linter is the deterministic check engine. It runs once, against one project, returns errors and warnings, exits.
78
+
79
+ It does **not**:
80
+
81
+ - Run continuously on every PR
82
+ - Push your customization to a sandbox tenant and run an end-to-end test suite before allowing the prod publish
83
+ - Take a snapshot of your current customization state with integrity verification before each publish (catching `merge=true` partial-publish corruption)
84
+ - Roll back automatically when a publish fails midway
85
+ - Review the C# code in `CustomizationPlugin.UpdateDatabase()` with AI to flag non-obvious correctness issues a static rule can't catch
86
+ - Post `:rotating_light:` Slack notifications when a publish fails
87
+ - Enforce deploy windows (no schema changes during business hours)
88
+ - Coordinate co-publishes with ISV packages without inflating the `publishBegin` page count past Acumatica's `ThreadAbortException` limit
89
+ - Issue + revoke per-VAR license keys with grace periods
90
+
91
+ All of that is **[AcuOps](https://acuops.com)** — the managed pipeline. $800/mo per Acumatica instance.
92
+
93
+ ## Founding partners
94
+
95
+ AcuOps is selecting 7–10 founding partners locked at **$500/mo for the life of subscription** in exchange for a published case study + reference availability. We're picking partners across VAR, ISV, in-house mid-market, and enterprise deployment patterns. → [Apply](https://acuops.com/founding-partners)
96
+
97
+ ## Contributing
98
+
99
+ Pull requests welcome. New rules should:
100
+
101
+ 1. Reference the originating production incident (AAR date, PR number, or both) in a comment
102
+ 2. Ship with both a positive example (`project.xml` snippet that triggers the rule) and a negative example
103
+ 3. Include an escape-hatch comment marker if the rule may have legitimate exceptions
104
+
105
+ Coding style is enforced by `ruff`. Run `pip install -e ".[dev]"` then `ruff check src/`.
106
+
107
+ ## License
108
+
109
+ Apache 2.0 — see [LICENSE](./LICENSE).
110
+
111
+ The Apache 2.0 patent grant protects all contributors from patent litigation over contributed code. This matters when the codebase encodes hard-won failure-mode knowledge from real production incidents.
112
+
113
+ ## Built by Studio B
114
+
115
+ Studio B ([studiob.ai](https://studiob.ai)) runs Acumatica deployments at scale across its portfolio. `acumatica-lint` is the static-check engine extracted from the AcuOps pipeline — the same code paths Studio B uses against its own production deployments.
116
+
117
+ The full pipeline → [acuops.com](https://acuops.com)
@@ -0,0 +1,69 @@
1
+ [build-system]
2
+ requires = ["setuptools>=61.0", "wheel"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "acumatica-lint"
7
+ version = "0.1.0"
8
+ description = "Free, open-source linter for Acumatica customization projects. The full pipeline is AcuOps."
9
+ readme = "README.md"
10
+ requires-python = ">=3.10"
11
+ license = { text = "Apache-2.0" }
12
+ authors = [
13
+ { name = "Studio B", email = "hello@studiob.ai" },
14
+ ]
15
+ keywords = [
16
+ "acumatica",
17
+ "linter",
18
+ "customization",
19
+ "validate",
20
+ "project.xml",
21
+ "static-analysis",
22
+ "devops",
23
+ ]
24
+ classifiers = [
25
+ "Development Status :: 4 - Beta",
26
+ "Environment :: Console",
27
+ "Intended Audience :: Developers",
28
+ "Intended Audience :: Information Technology",
29
+ "License :: OSI Approved :: Apache Software License",
30
+ "Operating System :: OS Independent",
31
+ "Programming Language :: Python :: 3",
32
+ "Programming Language :: Python :: 3.10",
33
+ "Programming Language :: Python :: 3.11",
34
+ "Programming Language :: Python :: 3.12",
35
+ "Programming Language :: Python :: 3.13",
36
+ "Topic :: Software Development :: Quality Assurance",
37
+ "Topic :: Software Development :: Build Tools",
38
+ ]
39
+ dependencies = [
40
+ # PyYAML powers the acuops.yaml ISV co-publish allowlist parsing.
41
+ # All other validators are stdlib-only.
42
+ "pyyaml>=6.0",
43
+ ]
44
+
45
+ [project.optional-dependencies]
46
+ dev = [
47
+ "pytest>=7.0",
48
+ "ruff>=0.5",
49
+ ]
50
+
51
+ [project.urls]
52
+ Homepage = "https://acuops.com"
53
+ Repository = "https://github.com/studio-b-ai/acumatica-lint"
54
+ "Issue tracker" = "https://github.com/studio-b-ai/acumatica-lint/issues"
55
+ "Full pipeline (AcuOps)" = "https://acuops.com"
56
+
57
+ [project.scripts]
58
+ acumatica-lint = "acumatica_lint.validate:main"
59
+
60
+ [tool.setuptools.packages.find]
61
+ where = ["src"]
62
+
63
+ [tool.ruff]
64
+ target-version = "py310"
65
+ line-length = 100
66
+
67
+ [tool.ruff.lint]
68
+ select = ["E", "F", "W", "I", "B"]
69
+ ignore = ["E501"] # Line length — validate.py has long error messages by design
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
@@ -0,0 +1,24 @@
1
+ """acumatica-lint — free, open-source linter for Acumatica customization projects.
2
+
3
+ Catches common project.xml format errors that cause silent failures or
4
+ NullReferenceExceptions on publish. Encodes ~60 failure-mode rules from real
5
+ Acumatica production incidents.
6
+
7
+ Run locally or in your CI:
8
+
9
+ acumatica-lint Customization/MyPackage/project.xml
10
+ acumatica-lint --strict Customization/MyPackage/project.xml
11
+
12
+ The full pipeline — continuous gating on every PR, sandbox dry-run before
13
+ prod, snapshot/rollback with integrity verification, Codex AI review, Slack
14
+ telemetry, deploy-window enforcement, and ~60 failure-mode guards — is
15
+ AcuOps: https://acuops.com.
16
+
17
+ Built by Studio B (https://studiob.ai). Apache 2.0 licensed.
18
+ """
19
+
20
+ __version__ = "0.1.0"
21
+
22
+ from .validate import main as validate_main
23
+
24
+ __all__ = ["__version__", "validate_main"]
@@ -0,0 +1,6 @@
1
+ """acumatica-lint CLI entry point — `python -m acumatica_lint <project.xml>`."""
2
+
3
+ from .validate import main
4
+
5
+ if __name__ == "__main__":
6
+ main()