CheckPackageJsonScripts class

Checks that a TypeScript project's package.json declares every npm script gg relies on and wires them into the expected publish chain (prepublishOnly → build → test):

  • test, build and lint scripts must all be present — build and lint only when the project carries a tsconfig.json. A hybrid without one ships no TypeScript sources, so there is nothing to compile or lint and only test is required.
  • The build script must run test, so the tests always run as part of a build. A prebuild script running test counts too, because npm runs it right before build. Hybrids are exempt, as their build produces the Dart and TypeScript artifacts and runs its tests separately.
  • prepublishOnly (or the deprecated prepublish) must be present and reach the tests — via build where there is one, directly otherwise.

Packages marked "private": true are never published and are therefore exempt from the prepublishOnly requirement (the build → test rule still applies to private pure-TypeScript packages).

Dart and Flutter projects are skipped. Cross-language bridge repos are checked as TypeScript (see checkProjectType).

Inheritance
  • Object
  • Command
  • CheckPackageJsonScripts
Implementers

Constructors

CheckPackageJsonScripts({required GgLog ggLog})
Constructor.
CheckPackageJsonScripts.example()
Example instance for tests — logs to print.
factory

Properties

aliases → List<String>
Alternate names for this command.
no setterinherited
argParser → ArgParser
The argument parser for this command.
no setterinherited
argResults → ArgResults?
The parsed argument results for this command.
no setterinherited
category → String
The command's category.
no setterinherited
description → String
finalinherited
dirFromArgs → Directory
Returns the directory from the command line arguments
no setterinherited
ggLog → GgLog
The log function
finalinherited
globalResults → ArgResults?
The parsed global argument results.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
hidden → bool
Whether or not this command should be hidden from help listings.
no setterinherited
invocation → String
A single-line template for how to invoke this command (e.g. "pub get package").
no setterinherited
name → String
The name of the command
finalinherited
parent → Command?
The command's parent command, if this is a subcommand.
no setterinherited
runner → CommandRunner?
The command runner for this command.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
subcommands → Map<String, Command>
An unmodifiable view of all sublevel commands of this command.
no setterinherited
suggestionAliases → List<String>
Alternate non-functional names for this command.
no setterinherited
summary → String
A short description of this command, included in parent's CommandRunner.usage.
no setterinherited
takesArguments → bool
Whether or not this command takes positional arguments in addition to options.
no setterinherited
usage → String
Generates a string displaying usage information for this command.
no setterinherited
usageFooter → String?
An optional footer for usage.
no setterinherited

Methods

absolute(Directory dir) → Directory
the input directory as absolute path
inherited
addSubcommand(Command command) → void
Adds Command as a subcommand of this.
inherited
check({required Directory directory}) → Future<void>
Returns true if the directory exists
inherited
dirName(Directory dir) → String
The name of the directory to be checked
inherited
exec({required Directory directory, required GgLog ggLog, Map<String, dynamic> options = const {}}) → Future<void>
Must be implemented in subclasses See DirCommandExample how to override this method
inherited
get({required Directory directory, required GgLog ggLog}) → Future<void>
Must be implemented in subclasses See DirCommandExample how to override this method
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
printUsage() → void
Prints the usage information for this command.
inherited
run() → Future<void>
Runs this command.
inherited
toString() → String
A string representation of this object.
inherited
usageException(String message) → Never
Throws a UsageException with message.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited