Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Configuration File to influence generation of PlantUML script / diagram #10

Closed
MarcoEidinger opened this issue Feb 18, 2021 · 0 comments · Fixed by #13
Closed

Configuration File to influence generation of PlantUML script / diagram #10

MarcoEidinger opened this issue Feb 18, 2021 · 0 comments · Fixed by #13
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@MarcoEidinger
Copy link
Owner

Configure generation of PlantUML script and with a configuration file (.yml) .

  • specify built-in PlantUML options, e.g. skinparam shall be covered.
  • allow SwiftPlantUML specific options, e.g. including elements (class, struct, enum, ...) in PlantUML script based on their access level.

Example:

output: browser
files:
  include:
  - Sources/SwiftPlantUMLFramework/Plant*.swift
  exclude:
  - Tests
generateElementsWithAccessLevel:
- public
- internal
- private
generateMembersWithAccessLevel:
- public
- internal
- private
showGenerics: true
hideShowCommands:
- hide empty members
skinparamCommands:
- skinparam shadowing false
relationships:
  struct:
    lineStyle: bold
    lineColor: AliceBlue
    textColor: AntiqueWhite
relationshipLabels:
  inheritance: inherits
  realize: confirms to
  dependency: ext
stereotypes:
  class:
    spot:
      character: C
      color: DarkSeaGreen
  struct:
    name: struct
    spot:
      character: S
      color: SkyBlue
  extension:
    name: extension
    spot:
      character: X
      color: Orchid
  enum:
    name: enum
    spot:
      character: E
      color: LightSteelBlue
  protocol:
    name: protocol
    spot:
      character: P
      color: GoldenRod

The plan is to support a single configuration file for the file scanning process. Multiple/Nested configuration files like in SwiftLint (Reference) is not planned.

@MarcoEidinger MarcoEidinger added the enhancement New feature or request label Feb 18, 2021
@MarcoEidinger MarcoEidinger added this to the 0.3.0 milestone Feb 18, 2021
@MarcoEidinger MarcoEidinger self-assigned this Feb 18, 2021
MarcoEidinger added a commit that referenced this issue Mar 1, 2021
being able to include/exclude files (wildcards supported)
being able to include/exclude elements by name (wildcard supported)
being able to limit elements and members bases on their access level
being able to hide extensions
being able to hide member access level attribute
being able to configure styles and skin parameter
being able to include external PUML files (theming)

✅ Closes: #9, #10, #12
MarcoEidinger added a commit that referenced this issue Mar 1, 2021
being able to include/exclude files (wildcards supported)
being able to include/exclude elements by name (wildcard supported)
being able to limit elements and members bases on their access level
being able to hide extensions
being able to hide member access level attribute
being able to configure styles and skin parameter
being able to include external PUML files (theming)

✅ Closes: #9, #10, #12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant