Merge pull request digitsensitive#48 from digitsensitive/release/v1.2.7

Release/v1.2.7
mattkenefick · Apr 26, 2023 · 8607ffa · 8607ffa
2 parents 374d55e + 0f0153a
commit 8607ffa
Show file tree

Hide file tree

Showing 23 changed files with 499 additions and 72 deletions.
diff --git a/.github/workflows/learn-github-actions.yml b/.github/workflows/learn-github-actions.yml
diff --git a/.github/workflows/publish-package-to-npmjs.yml b/.github/workflows/publish-package-to-npmjs.yml
@@ -0,0 +1,19 @@
+name: Publish Package to npmjs
+run-name: ${{ github.actor }} published a new Package to npmjs
+on:
+ release:
+ types: [published]
+jobs:
+ build:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v3
+ # Setup .npmrc file to publish to npm
+ - uses: actions/setup-node@v3
+ with:
+ node-version: '16.x'
+ registry-url: 'https://registry.npmjs.org'
+ - run: npm ci
+ - run: npm publish
+ env:
+ NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -14,13 +14,18 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ---
 
-## [1.X.X] - 2023-XX-XX
+## [1.2.7] - 2023-04-26
+
+### Added
+
+- Implement `Get as close as possible` option when the path is blocked ([Issue #10, @sefabaser](https://github.com/digitsensitive/astar-typescript/issues/10))
 
 ### Changed
 
 - Update most dependencies in `./` and `./example`
-- Update Copyright to 2013 in different locations
-- Small optimizations in `grid.ts`
+- Update Copyright to 2023 in different locations
+- Small optimizations in `grid.ts` and `util.ts`
+- Add `CopyPlugin` and `HtmlWebpackPlugin` to webpack
 
 ---
 

diff --git a/README.md b/README.md
@@ -131,6 +131,8 @@ let myPathway = this.aStarInstance.findPath(startPos, goalPos);
 
 Additional parameters may be passed to adapt your finder.
 
+### Diagonal movements
+
 If you want to disable `diagonal movements`:
 
 ```ts
@@ -143,6 +145,8 @@ this.aStarInstance = new AStarFinder({
 });
 ```
 
+### Heuristic function
+
 Set the `heuristic function` (Manhattan, Euclidean, Chebyshev or Octile):
 
 ```ts
@@ -172,6 +176,8 @@ this.aStarInstance = new AStarFinder({
 });
 ```
 
+### Start and End Node
+
 Include or Exclude the `start and end node`:
 
 ```ts
@@ -185,6 +191,18 @@ this.aStarInstance = new AStarFinder({
 });
 ```
 
+### Allow path as close as possible
+
+```ts
+this.aStarInstance = new AStarFinder({
+ grid: {
+ width: 8,
+ height: 8
+ },
+ allowPathAsCloseAsPossible: true
+});
+```
+
 ## Prettier
 
 This library uses [Prettier](https://github.com/prettier/prettier).

diff --git a/example/package.json b/example/package.json
@@ -17,7 +17,9 @@
  },
  "devDependencies": {
  "@types/dat.gui": "0.7.7",
+ "copy-webpack-plugin": "11.0.0",
  "expose-loader": "4.1.0",
+ "html-webpack-plugin": "5.5.1",
  "ts-loader": "9.4.2",
  "typescript": "5.0.4",
  "webpack": "5.80.0",

diff --git a/example/assets/images/node.png → example/src/assets/images/node.png b/example/assets/images/node.png → example/src/assets/images/node.png
diff --git a/example/assets/pack.json → example/src/assets/pack.json b/example/assets/pack.json → example/src/assets/pack.json
diff --git a/example/styles/css/styles.css → example/src/assets/styles/css/styles.css b/example/styles/css/styles.css → example/src/assets/styles/css/styles.css
diff --git a/example/styles/less/styles.less → example/src/assets/styles/less/styles.less b/example/styles/less/styles.less → example/src/assets/styles/less/styles.less
diff --git a/example/game.ts → example/src/game.ts b/example/game.ts → example/src/game.ts
diff --git a/example/index.html → example/src/index.html b/example/index.html → example/src/index.html
@@ -2,10 +2,14 @@
 <html lang="en">
  <head>
  <meta charset="UTF-8" />
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
  <meta name="author" content="digitsensitive" />
  <title>astar-typescript-example</title>
- <link rel="stylesheet" type="text/css" href="styles/css/styles.css" />
- <script src="dist/bundle.js"></script>
+ <link
+ rel="stylesheet"
+ type="text/css"
+ href="assets/styles/css/styles.css"
+ />
  </head>
  <body>
  <div id="game"></div>

diff --git a/example/objects/gameobject.ts → example/src/objects/gameobject.ts b/example/objects/gameobject.ts → example/src/objects/gameobject.ts
diff --git a/example/scenes/boot-scene.ts → example/src/scenes/boot-scene.ts b/example/scenes/boot-scene.ts → example/src/scenes/boot-scene.ts
diff --git a/example/scenes/main-scene.ts → example/src/scenes/main-scene.ts b/example/scenes/main-scene.ts → example/src/scenes/main-scene.ts
@@ -5,7 +5,7 @@
  * @license {@link https://opensource.org/licenses/MIT|MIT License}
  */
 
-import { AStarFinder } from '../../lib/astar';
+import { AStarFinder } from '../../../dist/astar';
 import { DatGuiService } from '../services/dat-gui.service';
 import { GameObject } from '../objects/gameobject';
 

diff --git a/example/services/dat-gui.service.ts → example/src/services/dat-gui.service.ts b/example/services/dat-gui.service.ts → example/src/services/dat-gui.service.ts
diff --git a/example/webpack.config.js b/example/webpack.config.js
@@ -1,17 +1,36 @@
 const path = require('path');
 
+// Copy files or entire directories, which already exist, to the build folder
+const CopyPlugin = require('copy-webpack-plugin');
+
+// Simplify creation of HTML files to serve your webpack bundles
+const HtmlWebpackPlugin = require('html-webpack-plugin');
+
 module.exports = {
- entry: path.resolve(__dirname, 'game.ts'),
+ entry: './src/game.ts',
  output: {
  path: path.resolve(__dirname, 'dist'),
- filename: 'bundle.js'
+ // It is generally better to use [chunkhash] in the filename instead of a
+ // fixed filename, especially in production builds.
+ // When you use a fixed filename, the browser may cache the file and reuse
+ // it even if you make updates to your code. This means that users may not
+ // see the updated code until they clear their cache, which can lead to
+ // confusion and errors.
+ // By using [chunkhash] in the filename, webpack will generate a unique hash
+ // for each chunk based on its contents. When the contents of a chunk change,
+ // the hash value changes, resulting in a new filename.
+ filename: '[name].[chunkhash].js',
+ chunkFilename: '[name].[chunkhash].js',
+ // Remove all files in the output directory that are not generated by the
+ // current build
+ clean: true
  },
  module: {
  rules: [
  {
  test: /\.ts$/,
- use: 'ts-loader',
- exclude: /node_modules/
+ include: path.resolve(__dirname, 'src'),
+ loader: 'ts-loader'
  },
  {
  test: require.resolve('Phaser'),
@@ -21,15 +40,33 @@ module.exports = {
  ]
  },
  devServer: {
- static: path.resolve(__dirname, './'),
- host: 'localhost',
- port: 8080,
- open: false
+ static: path.join(__dirname, 'dist')
  },
  resolve: {
- extensions: ['.ts', '.js'],
- alias: {
- phaser: path.join(__dirname, '/node_modules/phaser/dist/phaser.js')
+ extensions: ['.ts', '.js']
+ },
+ // The SplitChunksPlugin is a built-in plugin in webpack that helps to split
+ // your code into separate chunks, which can improve the performance of your
+ // application by reducing the size of each individual bundle.
+ optimization: {
+ splitChunks: {
+ chunks: 'all'
  }
- }
+ },
+ plugins: [
+ new CopyPlugin({
+ patterns: [
+ {
+ from: 'src/assets/',
+ to: 'assets/'
+ }
+ ]
+ }),
+ new HtmlWebpackPlugin({
+ template: path.resolve(__dirname, 'src/index.html'),
+ filename: 'index.html',
+ title: 'astar-typescript-example',
+ inject: 'head'
+ })
+ ]
 };