jensastrup / shortcut Goto Github PK

File directories started usage of interfaces, but I'm backtracking and sticking with contracts

Test CI job should run on all PRs and push to develop branch

Imports should be followed by 2 newlines

History is currently just an object - the keys appear to be in camelCase, but dates aren't converted and links to stories/iterations could be provided

Each resource/service should state which operations (list, search, etc) are available for that resource/service and an error should be thrown if attempting to call a method not in that list

https://developer.shortcut.com/api/rest/v3#Custom-Fields

Should also be available on stories

baseUrl is current set as static which is incorrect and causes failures on all service HTTP requests

https://developer.shortcut.com/api/rest/v3#Search-Iterations

https://developer.shortcut.com/api/rest/v3#Key-Results

• Iterations creation code example is incorrect
• Add section comparing shortcut client usage to this package

https://developer.shortcut.com/api/rest/v3#Story-Links

Only run tests if code under src/ changes

Interface parameter that's a generic type should be moved to an attribute of the class

public static resourceInterface = <SomeInterface>

Have docs generated during action, remove docs/ from repo

Linter should run on all PRs and fail if it would fix anything

Add test coverage for stories service

Interface should be a BaseInterface type, we shouldn't be using unknown

It should be possible to retrieve Team instances from an iteration instance

URL is currently doubling the "epics" part of the URL, it should be removed

https://developer.shortcut.com/api/rest/v3#Milestones

https://developer.shortcut.com/api/rest/v3#Files

https://developer.shortcut.com/api/rest/v3#Linked-Files

Remove form data package that is unused

Inadvertently using both axios and node-fetch, these should be consolidated

src/stories/stories-service.ts overrides the create method and can likely be removed.

Iteration.STARTED, etc

Add full test coverage for member and members-service

https://developer.shortcut.com/api/rest/v3#Epic-Workflow

Rather than throwing an error if, for example, iterationId is null we should return null

This requires fleshing out history

https://developer.shortcut.com/api/rest/v3#Repositories

BaseSearchableService is returning converted fields that aren't instantiated as a class/resource

Add ability to directly get state from Story, ie story.state == WorkflowState.STARTED

Shortcut Rest API, V3

StoryComment is attempting to import from the stories index file which is breaking when imports get converted during build

https://developer.shortcut.com/api/rest/v3#External-Link

Add support on stories

Subset of stories

https://developer.shortcut.com/api/rest/v3#Get-Task