Skip to content

Add Vale#11258

Open
dbreseman wants to merge 24 commits into
developmentfrom
db-vale
Open

Add Vale#11258
dbreseman wants to merge 24 commits into
developmentfrom
db-vale

Conversation

@dbreseman
Copy link
Copy Markdown
Collaborator

No description provided.

@mendix mendix deleted a comment from github-actions Bot May 28, 2026
@dbreseman dbreseman self-assigned this May 28, 2026
Copy link
Copy Markdown
Collaborator

@MarkvanMents MarkvanMents left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great. Can't wait to try it out locally.
I've made a couple of suggestions - but we can always add/change things later as we get used to the tool
Thanks for doing this.
Mark.


jobs:
vale:
# Only run on Mendix repo, not forks, and not on draft PRs
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this mean it won't run on developer-submitted PRs?
Would it be better to run it on all PRs that target development?
Perhaps we can extend it to that if it is successful?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point, and you're right—this will only include internal PRs rather than all PRs that target development. I think let's plan to expand it in a week if we're happy with how it's going?

Comment thread .gitignore
/.claude/audit.log
/.claude/settings.local.json
/.mcp.json
/.vale/styles/Microsoft/
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this something that the Vale package creates itself?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes! It's the Microsoft package from Vale: https://github.com/vale-cli/packages#available-styles

- JSON
- JSX
- LESS
- LLDB
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we have MDA and MPR here? The acronyms don't actually make much sense (even if you can remember what they are). Are there any other Mendix acronyms which don't need explaining?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll add those. I'm sure we will come up with more acronyms to add as we go along, so this will be a growing list.

first: '\b([A-Z]{3,5})\b'
second: '(?:\b[A-Za-z][a-z]+ )+\(([A-Z]{3,5})\)'
# ... with the exception of these:
exceptions:
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I presume this also covers jar and zip which I tend to see in lowercase.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, those won't be flagged—the regex only matches capitalized acronyms, so anything lowercase will just slip through.


# Common individual words
'\bgrey\b': 'gray'
'\bwhilst\b': 'while'
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😒

'data-set': 'dataset'
'data set': 'dataset'
'end point': 'endpoint'
'check box': 'checkbox'
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'end user': 'end-user'?

@dbreseman dbreseman marked this pull request as ready for review June 2, 2026 14:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants