@civ-clone/base-terrain-feature-furs 0.0.0-stage → 0.1.0

package/.gitattributes

@@ -0,0 +1,2 @@
+**/*.js linguist-generated=true
+

package/.github/workflows/build-on-push.yml

@@ -0,0 +1,39 @@
+name: Build and test application on push to remote
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 11
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+      # No lock file, so this tests what a consumer resolves. The settings match
+      # web-renderer's pnpm-workspace.yaml: several @civ-clone packages depend on
+      # each other as `github:` URLs, this project's own releases are often only
+      # minutes old, and nothing here needs a dependency's build script.
+      - run: >-
+          pnpm install --no-frozen-lockfile
+          --config.block-exotic-subdeps=false
+          --config.minimum-release-age=0
+          --config.strict-dep-builds=false
+      - run: npm run --if-present prettier:check
+      # The tests load the committed `.js`, so compile to prove the source
+      # type-checks, and fail if the committed output is stale. `--force`
+      # because a fresh checkout's timestamps can make `tsc --build` treat the
+      # committed output as up to date and skip the compile entirely.
+      - run: npm run --if-present ts:compile -- --force
+      - run: npm run --if-present prettier:format
+      # Stale *or never committed* output fails: `git diff` alone misses a new
+      # module whose `.js` was never added, which the published package would
+      # then omit. Only the compiled extensions, so the lock file the install
+      # writes cannot fail it; `node_modules` is ignored, so it stays out.
+      - run: |
+          git status --short --untracked-files=all -- '*.js' '*.d.ts' '*.js.map'
+          test -z "$(git status --porcelain --untracked-files=all -- '*.js' '*.d.ts' '*.js.map')"
+      - run: npm run --if-present test

package/.prettierrc

@@ -0,0 +1,4 @@
+{
+  "semi": true,
+  "singleQuote": true
+}

package/Furs.d.ts

@@ -0,0 +1,3 @@
+import TerrainFeature from '@civ-clone/core-terrain-feature/TerrainFeature';
+export declare class Furs extends TerrainFeature {}
+export default Furs;

package/Furs.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Furs = void 0;
+const TerrainFeature_1 = require("@civ-clone/core-terrain-feature/TerrainFeature");
+class Furs extends TerrainFeature_1.default {
+}
+exports.Furs = Furs;
+exports.default = Furs;
+//# sourceMappingURL=Furs.js.map

package/Furs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Furs.js","sourceRoot":"","sources":["Furs.ts"],"names":[],"mappings":";;;AAAA,mFAA4E;AAE5E,MAAa,IAAK,SAAQ,wBAAc;CAAG;AAA3C,oBAA2C;AAE3C,kBAAe,IAAI,CAAC"}

package/Furs.ts

@@ -0,0 +1,5 @@
+import TerrainFeature from '@civ-clone/core-terrain-feature/TerrainFeature';
+
+export class Furs extends TerrainFeature {}
+
+export default Furs;

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Dom Hastings
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,17 @@
-# Temporary Holding Version
+# base-terrain-feature-furs
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The `Furs` terrain feature: a special resource a square can hold.
+
+For example: Civ2's Furs, found on Tundra.
+
+This package only declares the class: it has no `main` and registers nothing, so installing it changes no game.
+A game's rules register it and give it its yields.
+
+```ts
+import Furs from '@civ-clone/base-terrain-feature-furs/Furs';
+import { instance as availableTerrainFeatureRegistryInstance } from '@civ-clone/core-terrain-feature/AvailableTerrainFeatureRegistry';
+
+availableTerrainFeatureRegistryInstance.register(Furs);
+```
+
+Part of the Civ2 work (civ-clone/web-renderer#1008).

package/package.json

@@ -1,6 +1,35 @@
 {
   "name": "@civ-clone/base-terrain-feature-furs",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.0",
+  "description": "The Furs terrain feature class.",
+  "repository": "git@github.com:civ-clone/base-terrain-feature-furs.git",
+  "keywords": [
+    "typescript",
+    "civilization"
+  ],
+  "author": "dom111 <dom111@users.noreply.github.com>",
+  "license": "MIT",
+  "private": false,
+  "scripts": {
+    "build": "npm run ts:compile && npm run prettier:format",
+    "prettier:check": "prettier --config .prettierrc --check '**/*.ts'",
+    "prettier:format": "prettier --config .prettierrc '**/*.ts' --write",
+    "test": "ts-mocha ./tests/*.test.ts",
+    "ts:compile": "tsc --build tsconfig.json"
+  },
+  "devDependencies": {
+    "@civ-clone/core-rule": "^0.1.9",
+    "@civ-clone/core-terrain": "^0.1.4",
+    "@types/chai": "^4.0.0",
+    "@types/mocha": "^8.0.0",
+    "@types/node": "^14.18.63",
+    "chai": "^4.0.0",
+    "mocha": "^9.0.0",
+    "prettier": "^2.8.8",
+    "ts-mocha": "^9.0.0",
+    "typescript": "^4.9.5"
+  },
+  "dependencies": {
+    "@civ-clone/core-terrain-feature": "^0.1.5"
+  }
+}

package/tests/Furs.test.ts

@@ -0,0 +1,18 @@
+import Furs from '../Furs';
+import { Land } from '@civ-clone/core-terrain/Types';
+import RuleRegistry from '@civ-clone/core-rule/RuleRegistry';
+import TerrainFeature from '@civ-clone/core-terrain-feature/TerrainFeature';
+import { expect } from 'chai';
+
+class Ground extends Land {}
+
+describe('Furs', (): void => {
+  it('should be a terrain feature of its terrain', (): void => {
+    const terrain = new Ground(new RuleRegistry()),
+      feature = new Furs(terrain);
+
+    expect(feature).to.be.instanceOf(TerrainFeature);
+    expect(feature.terrain()).to.equal(terrain);
+    expect(feature.clone()).to.be.instanceOf(Furs);
+  });
+});

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "declaration": true,
+    "lib": [
+      "es2019"
+    ],
+    "module": "commonjs",
+    "sourceMap": true,
+    "strict": true,
+    "target": "ES2018"
+  },
+  "exclude": [
+    "node_modules",
+    "tests/*.test.ts"
+  ]
+}