@shipload/sdk 0.0.1

package/.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

package/.eslintrc

@@ -0,0 +1,28 @@
+{
+    "root": true,
+    "ignorePatterns": ["lib/*", "tests/*", "node_modules/**"],
+    "extends": [
+        "eslint:recommended",
+        "plugin:@typescript-eslint/eslint-recommended",
+        "plugin:@typescript-eslint/recommended",
+        "plugin:prettier/recommended"
+    ],
+    "rules": {
+        "prettier/prettier": "warn",
+        "no-console": "warn",
+        "sort-imports": [
+            "warn",
+            {
+                "ignoreCase": true,
+                "ignoreDeclarationSort": true
+            }
+        ],
+        "@typescript-eslint/no-empty-interface": "off", // TODO: This should be removed before PR #1
+        "@typescript-eslint/explicit-module-boundary-types": "off",
+        "@typescript-eslint/no-explicit-any": "off",
+        "@typescript-eslint/no-namespace": "off",
+        "@typescript-eslint/no-non-null-assertion": "off",
+        "@typescript-eslint/no-empty-function": "warn",
+        "no-inner-declarations": "off"
+    }
+}

package/.prettierrc

@@ -0,0 +1,8 @@
+arrowParens: "always"
+bracketSpacing: false
+endOfLine: "lf"
+printWidth: 100
+semi: false
+singleQuote: true
+tabWidth: 4
+trailingComma: "es5"

package/Makefile

@@ -0,0 +1,74 @@
+SHELL := /bin/bash
+SRC_FILES := $(shell find src -name '*.ts')
+TEST_FILES := $(shell find test/tests -name '*.ts')
+BIN := ./node_modules/.bin
+MOCHA_OPTS := -u tdd -r ts-node/register -r tsconfig-paths/register --extension ts
+NYC_OPTS := --temp-dir build/nyc_output --report-dir build/coverage
+
+lib: ${SRC_FILES} package.json tsconfig.json node_modules rollup.config.js
+	@${BIN}/rollup -c && touch lib
+
+.PHONY: test
+test: node_modules
+	@TS_NODE_PROJECT='./test/tsconfig.json' MOCK_DIR='./test/data' \
+		${BIN}/mocha ${MOCHA_OPTS} ${TEST_FILES} --no-timeout --grep '$(grep)'
+
+test/watch: node_modules
+	@TS_NODE_PROJECT='./test/tsconfig.json' \
+		${BIN}/mocha --watch ${MOCHA_OPTS} ${TEST_FILES} --no-timeout --grep '$(grep)'
+
+build/coverage: ${SRC_FILES} ${TEST_FILES} node_modules
+	@TS_NODE_PROJECT='./test/tsconfig.json' MOCK_DIR='./test/data' \
+		${BIN}/nyc ${NYC_OPTS} --reporter=html \
+		${BIN}/mocha ${MOCHA_OPTS} -R nyan ${TEST_FILES}
+
+.PHONY: coverage
+coverage: build/coverage
+	@open build/coverage/index.html
+
+.PHONY: ci-test
+ci-test: node_modules
+	@TS_NODE_PROJECT='./test/tsconfig.json' MOCK_DIR='./test/data' \
+		${BIN}/nyc ${NYC_OPTS} --reporter=text \
+		${BIN}/mocha ${MOCHA_OPTS} -R list ${TEST_FILES}
+
+.PHONY: check
+check: node_modules
+	@${BIN}/eslint src test --ext .ts --max-warnings 0 --format unix && echo "Ok"
+
+.PHONY: format
+format: node_modules
+	@${BIN}/eslint src --ext .ts --fix
+
+.PHONY: docs
+docs: build/docs
+	@open build/docs/index.html
+
+build/docs: $(SRC_FILES) node_modules
+	@${BIN}/typedoc --out build/docs \
+		--excludeInternal --excludePrivate --excludeProtected \
+		--includeVersion --hideGenerator --readme none \
+		src/index.ts
+
+build/pages: build/coverage build/docs
+	@mkdir -p build/pages
+	@cp -r build/docs/* build/pages/
+	@cp -r build/coverage build/pages/coverage
+
+.PHONY: deploy-pages
+deploy-pages: | clean lib build/pages node_modules
+	@${BIN}/gh-pages -d build/pages
+
+build/browser.html: $(SRC_FILES) $(TEST_FILES) test/rollup.config.js node_modules
+	@${BIN}/rollup -c test/rollup.config.js
+
+node_modules:
+	yarn install --non-interactive --frozen-lockfile --ignore-scripts
+
+.PHONY: clean
+clean:
+	rm -rf lib/ build/ build/browser.html
+
+.PHONY: distclean
+distclean: clean
+	rm -rf node_modules/

package/README.md

@@ -0,0 +1 @@
+# SDK

package/lib/shipload.d.ts

@@ -0,0 +1,2 @@
+
+export {  }

package/lib/shipload.js

@@ -0,0 +1,4 @@
+'use strict';
+
+console.log('Hello!');
+//# sourceMappingURL=shipload.js.map

package/lib/shipload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shipload.js","sources":["../src/index.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAAA,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC;;"}

package/lib/shipload.m.js

@@ -0,0 +1,2 @@
+console.log('Hello!');
+//# sourceMappingURL=shipload.m.js.map

package/lib/shipload.m.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shipload.m.js","sources":["../src/index.ts"],"sourcesContent":[null],"names":[],"mappings":"AAAA,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC"}

package/package.json

@@ -0,0 +1,22 @@
+{
+    "name": "@shipload/sdk",
+    "module": "lib/shipload.m.js",
+    "type": "module",
+    "main": "lib/shipload.js",
+    "types": "lib/shipload.d.ts",
+    "unpkg": "lib/shipload.bundle.js",
+    "devDependencies": {
+        "@rollup/plugin-typescript": "^11.1.5",
+        "bun-types": "latest",
+        "rollup": "^4.0.2",
+        "rollup-plugin-cleanup": "^3.2.1",
+        "rollup-plugin-dts": "^6.1.0",
+        "tslib": "^2.6.2",
+        "typescript": "^5.2.2"
+    },
+    "peerDependencies": {
+        "typescript": "^5.0.0"
+    },
+    "dependencies": {},
+    "version": "0.0.1"
+}

package/rollup.config.js

@@ -0,0 +1,36 @@
+import dts from 'rollup-plugin-dts'
+import typescript from '@rollup/plugin-typescript'
+import cleanup from 'rollup-plugin-cleanup'
+import pkg from './package.json' assert {type: 'json'}
+
+const external = Object.keys(pkg.dependencies)
+
+/** @type {import('rollup').RollupOptions} */
+export default [
+    {
+        input: 'src/index.ts',
+        output: {
+            file: pkg.main,
+            format: 'cjs',
+            sourcemap: true,
+            exports: 'named',
+        },
+        plugins: [typescript({target: 'es6'}), cleanup({extensions: ['js', 'ts']})],
+        external,
+    },
+    {
+        input: 'src/index.ts',
+        output: {
+            file: pkg.module,
+            format: 'esm',
+            sourcemap: true,
+        },
+        plugins: [typescript({target: 'es2020'}), cleanup({extensions: ['js', 'ts']})],
+        external,
+    },
+    {
+        input: 'src/index.ts',
+        output: {file: pkg.types, format: 'esm'},
+        plugins: [dts(), cleanup({extensions: ['d.ts']})],
+    },
+]

package/src/index.ts

@@ -0,0 +1 @@
+console.log('Hello!')

package/tsconfig.json

@@ -0,0 +1,17 @@
+{
+    "compilerOptions": {
+        "downlevelIteration": true,
+        "esModuleInterop": true,
+        "experimentalDecorators": true,
+        "importHelpers": true,
+        "isolatedModules": true,
+        "lib": ["dom", "es2020"],
+        "module": "es2020",
+        "moduleResolution": "node",
+        "noImplicitAny": false,
+        "sourceMap": true,
+        "strict": true,
+        "target": "es2019"
+    },
+    "include": ["src/**/*"]
+}