eliziumnet / klassy Goto Github PK

The generate method needs to handle the scenari where there are no operations.

Related to EliziumNet/Krayola#37

fix(poshlog): Change by checking result of any git command is null before proceeding (#<12>)

This is caused by ReadGitCommitsInRange not checking the result the result of the git log command, before prceeding:

  [PSCustomObject[]] ReadGitCommitsInRange(
    [string]$Format,
    [string]$Range,
    [string[]]$Header,
    [string]$Delim
  ) {
    Write-Debug "ReadGitCommitsInRange: RANGE: '$($Range)', FORMAT: '$($Format)'.";

    $commitContent = (git log $Range --format=$Format);
    [array]$result = $commitContent | ConvertFrom-Csv -Delimiter $Delim -Header $Header;

$commitContent could be null, so this should be checked for.

Perform analysis on the rest of the code t see if there are other similar scenarios.

On further consideration, this module should be a generic class container. Within this module, we can define separate silos of classes that may or may not depend on one another. Looking forward, I would not want to have to define a new module every time there is a requirement for a new set of classes. Klassy should be that class repository that clients (like Loopz and Krayola) can use to define their classes.

scope: changeLog
change: add
type: feat
commit: feat(changeLog): Add new ChangeLog class silo (#8)

Create change-log class silo.

should process the result for running this command:

git log --decorate --format='(%h), %as, %s' --grep=<pattern>

Elizium modules use commitizen compliant commits so the subject line should look something like this:

(doc #127): Create new inline function documentation for platyPS

However, this is NOT conventional commits which are of the form

<type>[optional scope]: <description>

So the only real difference is that we insert the issue number after the <type>

so we can use either

^\(?(?<type>fix|feat|build|chore|ci|docs|doc|style|ref|perf|test)\s+(?:#(?<n>\d{1,6}))?\)?:\s(?<desc>[\w\W\s]+)$

or the commitizen format (but with this, we will allow an optional #issue-no comes after the ': '

^(?<type>fix|feat|build|chore|ci|docs|doc|style|ref|perf|test)(?:\((?<scope>[\w]+)\))?:\s(?:#(?<n>\d{1,6}))?(?<desc>[\w\W\s]+)$

types: fix, feat, build, chore, ci, docs, style, ref, perf, test

See also:

• https://commitizen-tools.github.io/commitizen/changelog/
• https://www.conventionalcommits.org/en/v1.0.0/#summary

style(changeLog): change by renaming to PoShLog #NO

Style changes

• rename change log to PoShLog
• rename ChangeLogSchema to PoShLogProfile
• rename public properties on SourceControl

When you come to defining Change Log, add PoShLog isa: ChangeLog

feat(poshlog): change to allow insertion of a highlights section for each release (#<11>)

The default template will be

✨ HIGHLIGHTS

• Lorem ipsum dolor sit amet

or

HIGHLIGHTS

• Lorem ipsum dolor sit amet

• Selection.Subject.Include: "^\(?(?fix|feat|build|chore|ci|docs|doc|style|ref|perf|test)\s+(?:#(?\d{1,6}))?\)?(?!)?:?\s?(?[\w\W\s]+)"
• add default scopes (for emoji profiles only), "build": ":toolbox:", "changeLog": "isa:poshlog", "poshlog": ":scroll:", "docs": ":books:"

this code needs a tweak:

    [PSCustomObject]$result = if ($current.Label -eq 'HEAD') {
      [string]$latest = $allTags[1].Label;

      [PSCustomObject]@{
        Range = "$($latest)..HEAD";
        From  = $latest;
        Until = 'HEAD';
      }
    }

The problem in this scenario is that is generates the range "..HEAD" which is not valid. The correct range is simpy "HEAD", which means gets all commits.

In particular this is the line at fault which makes a rash assumption:

[string]$latest = $allTags[1].Label;

When swapping over the from and to, there was a problem in that the To, is only a filename/directory name, not the full path which ended up with an incorrect swap and an erroroneous Rename-Item command.

fix(poshlog): change isa relationalship to allow for lookup entries being remapped (#<10>)

      "Scopes": {
        "?": ":lock:",
        "all": ":star:",
        "Parameter Set tools": ":postbox:",
        "pstools": "isa:Parameter Set tools",
        "poshlog": ":star:",
        "changeLog": "isa:poshlog",
        "signals": ":fireworks:"
      },

Renaming a scope entry with an isa does not work resulting in:

Scope(isa:Parameter Set toolspstools)

instead of

Scope(:postbox:Parameter Set tools)

If a repo contains no tags/releases, PoShLog doesnt handle gracefully. IE tag list expected as an array returns null. Make sure all empty results returned as null are handled correctly.

This just requires a change to the config in the HighlightsContent:

HighlightContent = @('', '*{highlightDummy}');

Currently, operations are alerted but not immediate written to the script file. If a user runs a command and realises they made a mistake (and assuming whatIf is not enabled), then the immediate reaction would be to terminate the command which means the undo script never gets created.

The undo script should be populated immediately and constantly updated.

Forgot to change this in the default options.

Powered By 📜 Elizium.PoShLog

rename to New-ProxyGit

See: Everything you wanted to know about PSCustomObject

And also update function/method parameters that currently take [PSCustomObject] to PSTypeName

eg: "param( [PSTypeName('My.Object')]$Data )".

This adds some type safety to PSCustomObject.

And we can also apply to OutputType for return values.

Create helper factory which only exists in test form currently as New-TestChangeLog