Skip to content

feat!: dynamic filename conventions / no spaces in filenames#259

Merged
mnahkies merged 8 commits intomainfrom
mn/fix/no-spaces-in-filenames
Nov 2, 2024
Merged

feat!: dynamic filename conventions / no spaces in filenames#259
mnahkies merged 8 commits intomainfrom
mn/fix/no-spaces-in-filenames

Conversation

@mnahkies
Copy link
Owner

@mnahkies mnahkies commented Oct 27, 2024

Applies conventions to dynamically generated filenames, defaulting to kebab-case but configurable through new option --filename-convention

Sometimes you want spaces in your tag, such that this is rendered in <insert documentation tool> with a space, but don't want this to flow into your code filenames

BREAKING CHANGE: emitted filenames may change if not already in kebab-case format. Use --filename-convention if an alternative convention such as camel-case is preferred.

Base automatically changed from mn/111/unique-export-names to main October 27, 2024 16:55
@mnahkies mnahkies force-pushed the mn/fix/no-spaces-in-filenames branch 3 times, most recently from 0ffb31c to 3155cbf Compare November 2, 2024 10:48
@mnahkies mnahkies changed the title fix: no spaces in filenames feat: unique client export names, dynamic filename conventions Nov 2, 2024
mnahkies added a commit that referenced this pull request Nov 2, 2024
similar to #258,
split from #259

start exporting clients using unique names, whilst keeping the original
names for backwards compatibility.

the names are generated from the `info.title` field, which can
additionally be overridden by passing the new param:
```
--override-specification-title SomethingElse
```
- sometimes you want spaces in your `tag`, such that this is rendered
  in `<insert documentation tool>` with a space, but don't want this
  to flow into your code filenames

- before merging I'll probably make this an actual option, since
  different projects will have different preferences here, personally I
  like `names-like-this.ts`, but others will prefer `NamesLikeThis.ts`
@mnahkies mnahkies force-pushed the mn/fix/no-spaces-in-filenames branch from 95afc1c to 594876c Compare November 2, 2024 11:31
@mnahkies mnahkies changed the title feat: unique client export names, dynamic filename conventions feat: dynamic filename conventions Nov 2, 2024
@mnahkies mnahkies changed the title feat: dynamic filename conventions feat: dynamic filename conventions / no spaces in filenames Nov 2, 2024
@mnahkies mnahkies changed the title feat: dynamic filename conventions / no spaces in filenames feat!: dynamic filename conventions / no spaces in filenames Nov 2, 2024
@mnahkies mnahkies marked this pull request as ready for review November 2, 2024 11:40
@mnahkies mnahkies enabled auto-merge (squash) November 2, 2024 11:41
@mnahkies mnahkies merged commit c6a72b5 into main Nov 2, 2024
@mnahkies mnahkies deleted the mn/fix/no-spaces-in-filenames branch November 2, 2024 11:41
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.

1 participant