Skip to content

Order the scripts and follow naming standard in package.json #428

@trivikr

Description

@trivikr

Is your feature request related to a problem? Please describe.

The scripts written in base-package.json are not in order and does not follow a naming standard.
Link: https://github.com/awslabs/smithy-typescript/blob/80aa80a0c7faa106ff288969cd68b77ae1792925/smithy-typescript-codegen/src/main/resources/software/amazon/smithy/typescript/codegen/base-package.json#L5-L16

Describe the solution you'd like

  • Follow the naming standard used by build
    • rename remove-definitions to clean:types
    • rename remove-dist to clean:dist
    • rename remove-documentation to clean:docs
    • rename build-documentation to build:docs
  • Arrange the scripts in lexicographical order as follows:
{
	"build": "yarn build:cjs && yarn build:es",
	"build:cjs": "tsc -p tsconfig.json",
	"build:docs": "yarn clean:docs && typedoc ./",
	"build:es": "tsc -p tsconfig.es.json",
	"clean": "yarn clean:types && yarn clean:dist && yarn clean:docs",
	"clean:types": "rimraf ./types",
    "clean:dist": "rimraf ./dist",
	"clean:docs": "rimraf ./docs",
	"downlevel-dts": "downlevel-dts dist/types dist/types/ts3.4",
	"test": "jest --coverage --passWithNoTests"
}

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions