feat(interfaces): Scripts

Signed-off-by: Lexus Drumgold <[email protected]>

src/interfaces/__tests__/scripts.spec-d.ts

@@ -0,0 +1,21 @@
+/**
+ * @file Unit Tests - Scripts
+ * @module pkg-types/interfaces/tests/Scripts
+ */
+
+import type { JsonObject } from '@flex-development/tutils'
+import type TestSubject from '../scripts'
+
+describe('unit:interfaces/Scripts', () => {
+  it('should allow empty object', () => {
+    assertType<TestSubject>({})
+  })
+
+  it('should be json object', () => {
+    expectTypeOf<TestSubject>().toMatchTypeOf<JsonObject>()
+  })
+
+  it('should only have string values', () => {
+    expectTypeOf<TestSubject[string]>().toBeString()
+  })
+})

src/interfaces/index.ts

@@ -6,3 +6,4 @@
 export type { default as DependencyMap } from './dependency-map'
 export type { default as Directories } from './directories'
 export type { default as PublishConfig } from './publish-config'
+export type { default as Scripts } from './scripts'

src/interfaces/scripts.ts

@@ -0,0 +1,51 @@
+/**
+ * @file Interfaces - Scripts
+ * @module pkg-types/interfaces/Scripts
+ */
+
+import type { JsonObject } from '@flex-development/tutils'
+
+/**
+ * Package lifecycle scripts.
+ *
+ * @see https://docs.npmjs.com/cli/using-npm/scripts
+ * @see https://yarnpkg.com/advanced/lifecycle-scripts
+ * @see https://classic.yarnpkg.com/en/docs/package-json#toc-scripts
+ *
+ * @extends {JsonObject}
+ */
+interface Scripts extends JsonObject {
+  [script: string]: string
+
+  install?: string
+  postinstall?: string
+  postpack?: string
+  postpublish?: string
+  postrestart?: string
+  poststart?: string
+  poststop?: string
+  posttest?: string
+  postuninstall?: string
+  postversion?: string
+  preinstall?: string
+  prepack?: string
+  prepare?: string
+  prepublish?: string
+  prepublishOnly?: string
+  prerestart?: string
+  prestart?: string
+  prestop?: string
+  pretest?: string
+  preuninstall?: string
+  preversion?: string
+  publish?: string
+  restart?: string
+  start?: string
+  stop?: string
+  test?: string
+  typecheck?: string
+  uninstall?: string
+  version?: string
+}
+
+export type { Scripts as default }