Repo should be linked on the ttb npm page.

Acceptance criteria

• it should have repository specified in package.json
• it should have homepage specified in package.json

• options for branch command is not implemented even tho it was specified in the command
• issues with labels crashes the program

The --code flag is redundant and should be removed.

Current
jirabranchcreator --code=ST-108 --type=epic

Wanted
jirabranchcreator ST-108 --type=epic

As a user, I want to be able to view my credentials, so that I easily can get an overview over my added credentials.

Acceptance Criteria

• it should add a command named "list"
• it should list all credentials when running ttb list in the terminal

As a developer, I want strict linting and formatting to lean on so that the code is consistent and I do not need to care for the details of it when developing.

Acceptance Criteria

• it should install eslint
• it should install prettier
• it should configure eslint
• it should configure prettier

Notes

• remember that meanwhile we wanna apply what we see as best practices, we also should understand what is actually best practices in the CLI/node env.

Add information to this EPIC

User Stories

• #8
• #14
• #30

Publish to npm

Blocked by

• #23
• #22
• #24

Active credential needs to be accessible from other commands than use.

Implementation suggestion

• add a store to save states that needs to be accessible in multiple commands.

As a user I want TTB to create and checkout a new branch with one command so that I can spend more time on coding.

Acceptance criteria

• it should have appropriate error handling.
• it should make "ttb branch " create and checkout a new branch with a proper name that the ticket id provides.

Implementation suggestions

• make use of GitHubs "create a branch" to link the new branch with the ticket that was used to create the branch.

Epic Story

As a developer, I want a modern tool that can get tickets from a multitude of sources and create branches for them.

Acceptance Criteria

• it should be able to get tickets from Jira
• it should be able to get tickets from Github
• it should be written in Typescript
• it should be able to scale to get tickets from any modern ticketing system

Notes

• https://docs.github.com/en/rest

Links to interesting tools for CLI development

https://github.com/tj/commander.js
https://github.com/SBoudrias/Inquirer.js/
https://github.com/chalk/chalk
https://github.com/helloIAmPau/node-spinner
https://github.com/patorjk/figlet.js

User Stories

• #6
• #7
• #11
• #13
• #16

As a developer, I want TTB to be able to scale to consume different API:s so that I can use it for different ticketing systems.

Acceptance Criteria

• it should add support for multiple API clients
• it should support Github API over Graphql
• it should support JIRA API over REST

Notes

• FYI: maybe JIRA uses the same interface (using Graphql) meaning that we might not need to abstract the client now. Or maybe it still has some differences, and thereby is best to do just that... That will become evident in this ticket. That is part of why this ticket exists.
• JIRA graphql: https://developer.atlassian.com/platform/atlassian-graphql-api/graphql/#examples

Epics

• #26

As a developer I want the default branch to be dev so that PRs automatically has dev branch as base.

Acceptance criteria

• it should make dev branch the default branch of the repository
• it should make it impossible to create a PR into main from any other branch than dev

Notes

Main branch is the production branch

Epic Story

As a developer, I want to be able to install ttb as a npm package, so that I can use ttb in a consistent way

Acceptance Criteria

• it should have a readme that is true and helpful
• it should rename the repository to "ttb"
• it should not have legacy code in the repo

User Stories

• #23
• #22
• #24
• #25

There should be an option to add multiple host names so that you don't need to manually change host in credentials.json every time you want to create a branch in a new project.

Acceptance criteria

• it should make use of ts aliases instead of absolute paths

As a user I want to be able to add other prefixes than feature so that I can use this for more use cases

Acceptance criteria

• it should enable provision for a prefix argument
• it should be able to create a hotfix branch
• it should be able to create a bugfix branch
• it should be able to create release branch
• it should be able to create a custom prefix

To create a branch you should run ttb branch <id> <type?> to make it easier to understand the tool.

I want to be able to download this package without it being a git repository.

Suggestion: make use of degit instead of git clone.

Current
git clone [email protected]:bjornet/jirabranchcreator.git

Wanted
degit bjornet/jirabranchcreator

Update readme

• JIRA token should not be mentioned as of now
• Clarify what it is expected to do:
• 1. ESSENTIAL: create a local branch from a ticket number from github
• 2. if possible: link branch to issue in github

Acceptance criteria

• it should update all dependencies

Notes

Eslint shouldn't be updated to latest because of major braking changes. This should be done in a separate ticket.

Needs instructions for

• how to setup credentials
• how to install

As a user, when a "nice to have" feature goes wrong, I want the program tell me what went wrong but still do the essential steps.

Acceptance criteria

• it should check if a branch already exists
• it should tell the user if it failed to create a linked branch
• it should checkout a local branch:
  • if branch already exists
  • or it failed to create a linked branch

Notes

Message from Fille > "Jag skapade en Classic Personal Access Token och körde i alla permissions för att testa, men får följande fel:"

As a developer, I want a credential manager that is easy to use so that I can easily swap between different projects.

Acceptance Criteria

Implementation suggestion

// ~/.ttb/credentials.json

{
  "visitorToolbox": {
    "host": "visitortoolbox.atlassian.net",
    "email": "[email protected]",
  },
  "guestrix": {
    "host": "visitortoolbox.atlassian.net",
    "email": "[email protected]",
    "apiToken": "XhOewfehV7bSdEpqdAuP709D"
  }
}

// ## Improved UX
// a. `ttb <issue>`
// b. (if not authorized) show list of your credentials and select the correct one

As a Viktor, I want this repo to be super crisp so that I can contribute to it.

Acceptance Criteria

• it should be written in TS since Im a hipster dipster

Notes