@rpg-engine/shared 0.0.4 → 0.0.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/README.md +24 -6
  2. package/dist/types/AnimationTypes.d.ts +1 -1
  3. package/dist/types/AssetTypes.d.ts +1 -1
  4. package/dist/types/PreloadSceneTypes.js +1 -1
  5. package/package.json +2 -2
package/README.md CHANGED
@@ -1,11 +1,29 @@
1
- # `@rpg-engine/common`
1
+ # `@rpg-engine/shared`
2
2
 
3
- > TODO: description
3
+ # How to update our shared packages?
4
4
 
5
- ## Usage
5
+ # Important
6
6
 
7
- ```
8
- const common = require('@rpg-engine/common');
7
+ - You can push this project directly to master. Just make sure you're in sync with master before starting to work (git pull origin master)
8
+
9
+ # Pre-requisites:
10
+
11
+ - You must have the .npmrc file set on the root of this project. If you don't, [please check our notion documentation](https://www.notion.so/projectstockalert/Configuration-files-a1725ae8e64a497fb617d92a17ab29fd#7fe40aa161404c06b145c1b60c849495)
12
+
13
+ # Step-by-step:
14
+
15
+ 1. Implement your desired changes. Remember to export any types in index.ts
16
+
17
+ 2. `yarn publish`
9
18
 
10
- // TODO: DEMONSTRATE API
19
+ 3. Update back-end and front-end packages
20
+
21
+ References: https://cameronnokes.com/blog/the-30-second-guide-to-publishing-a-typescript-package-to-npm/
22
+
23
+ # Notes
24
+
25
+ - First time publishing will require you to explicitly set it to public:
26
+
27
+ ```
28
+ yarn publish --access public
11
29
  ```
package/dist/types/AnimationTypes.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- export declare type AnimationDirection = 'down' | 'up' | 'left' | 'right';
1
+ export declare type AnimationDirection = "down" | "up" | "left" | "right";
2
2
  export interface IAnimationData {
3
3
  [direction: string]: {
4
4
  walking: number[];
package/dist/types/AssetTypes.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- import { IAnimationData } from './AnimationTypes';
1
+ import { IAnimationData } from "./AnimationTypes";
2
2
  export interface IAssetData {
3
3
  textureKey: string;
4
4
  path: string;
package/dist/types/PreloadSceneTypes.js CHANGED
@@ -2,7 +2,7 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.PreloadSceneData = void 0;
4
4
  exports.PreloadSceneData = {
5
- key: 'PreloadScene',
5
+ key: "PreloadScene",
6
6
  assets: {},
7
7
  };
8
8
  //# sourceMappingURL=PreloadSceneTypes.js.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rpg-engine/shared",
3
- "version": "0.0.4",
3
+ "version": "0.0.5",
4
4
  "description": "> TODO: description",
5
5
  "author": "Joao Paulo Furtado <joaopaulofurtado@live.com>",
6
6
  "homepage": "",
@@ -20,7 +20,7 @@
20
20
  "test": "echo \"Error: no test specified\" && exit 1",
21
21
  "tsc": "tsc -p .",
22
22
  "prepublish": "tsc",
23
- "format": "prettier --write 'src/**/*.ts' 'src/**/*.json' --loglevel silent",
23
+ "format": "prettier --write 'src/**/*.ts' --loglevel silent",
24
24
  "format:check": "prettier --check '**/*.ts' '**/*.json'",
25
25
  "configure": "./environment/download-credentials.sh"
26
26
  },