Feature request: ignore abbreviations

[soc221b]

I'm wondering if this is useful to anyone else 🤔:

ls:
  packages/*/{src,__tests__}:
    .js: kebab-case
    .ts: camelCase | PascalCase
    .d.ts: camelCase
    .spec.ts: camelCase | PascalCase
    .mock.ts: camelCase

ignore:
  - node_modules
+
+ abbr:
+  - HTTP
+  - SMS

Thank you~

[loeffel-io]

Hey @iendeavor, could you please provide more context

thank you

[soc221b]

Hi, @loeffel-io
Thanks for your quick reply.

For example, we might have some files containing the abbreviation "SMS", but it violates the PascalCase rule:

ls:
  .ts: PascalCase

path/
│
└─ to/
  │
  ├─ EmailService.ts # valid
  │
  └─ SMSService.ts # invalid

[loeffel-io]

Hey @iendeavor

for this you can use the regex rule and allow only specific values or the negative of them with something like

ls:
    to:
         .ts: regex:(Email|Foo|Bla)Service # allow EmailService, FooService, BlaService

the negative could be this, but this isn't supported by re2 and go

ls:
    to:
         .ts: regex:(?!HTTP|SMS).*Service # do not allow HTTPService, SMSService

for this a not_regex rule could make sense

[soc221b]

Yes, this makes sense for the example mentioned earlier, but we might have any name anywhere in the filename, and we also want to validate it based on specific rules, like:

Example 1: https://github.com/facebook/react-native/tree/6e42c98aa3423cfbc389e4fe877b5c6b559c8a81/packages/community-cli-plugin/src/commands/bundle

ls:
  .js: camelCase

../
│
└─ bundle/
  │
  ├─ assetCatalogIOS.js
  │
  ├─ getAssetDestPathIOS.js
  │
  └─ __tests__/
    │
    └─ getAssetDestPathIOS-test.js

Example 2: https://github.com/apple/swift/tree/main/lib/AST

ls:
  .cpp: PascalCase

../
│
├─ AST/
│ │
│ ├─ ASTScope.cpp
│ │
│ ├─ ASTScopePrinting.cpp
│ │
│ └─ ASTScopeSourceRange.cpp
│
└─ RemoteAST/
  │
  └─ RemoteAST.cpp

[loeffel-io]

what about

ls:
    to:
         .ts: regex:(Email|Foo|Bla)Service | camelCase # allow EmailService, FooService, BlaService and all camelCase

filenames like getAssetDestPathIOS-test.js are an anti pattern imo

[loeffel-io]

Closing this for now - please let me know if you have any further questions