Merge pull request #26 from Live2D/develop

Update to Cubism 5 SDK for Web R1

Author: itoh-at-live2d-com

.eslintrc.yml

@@ -23,28 +23,83 @@ rules:
       format:
       - camelCase
     - selector: variable
+      format:
+      custom: {
+        # 指定の文字列で始まるものと特定の文字を含むものは許容
+        regex: '^[A-Z]|^csm|^iterator|Shader',
+        match: true
+      }
+      modifiers: ['exported','const']
+    - selector: variable
+      format:
+      - camelCase
+    - selector: variable
+      format:
+      custom: {
+        # 指定の文字列で始まるものは許容
+        regex: '^[A-Z]|^s_',
+        match: true
+      }
+      modifiers: ['global']
+    - selector: enum
+      format:
+      - PascalCase
+    - selector: enumMember
+      format:
+      custom: {
+        # 大文字から始まること
+        regex: '^[A-Z]',
+        match: true
+      }
+    - selector: classProperty
+      format:
+      - PascalCase
+      modifiers: ['static','readonly']
+    - selector: classProperty
       format:
       - camelCase
-      - UPPER_CASE
       leadingUnderscore: allow
-      trailingUnderscore: allow
     - selector: class
       format:
+      custom: {
+        # 指定の文字列で始まるか、指定の文字列で終わること
+        regex: '^[A-Z]|^csm|^iterator|_WebGL$',
+        match: true
+      }
+    - selector: interface
+      format:
+      - camelCase
       - PascalCase
-      trailingUnderscore: allow
     - selector: parameter
       format:
       - camelCase
-      leadingUnderscore: allow
-    - selector: memberLike
-      modifiers:
-      - private
+    - selector: classMethod
       format:
       - camelCase
-      leadingUnderscore: require
-    - selector: typeLike
+    - selector: objectLiteralProperty
       format:
+      - camelCase
       - PascalCase
+    - selector: typeAlias
+      format:
+      custom: {
+        # 指定の文字列で始まるものは許容
+        regex: '^[A-Z]|^[a-z]|^CSM_|^csm|^iterator',
+        match: true
+      }
+      modifiers: ['exported']
+    - selector: typeAlias
+      format:
+      - camelCase
+    - selector: typeParameter
+      format:
+      custom: {
+        # 「大文字+アンダースコア以外の文字」、あるいは「大文字1文字」
+        # あるいは、「`T`+アンダースコア」で始まる場合
+        regex: '^[A-Z][^_]|^[A-Z]|^T_$',
+        match: true
+      }
+      leadingUnderscore: allow
   '@typescript-eslint/no-use-before-define': off
   no-empty-function: off
   '@typescript-eslint/no-empty-function':

CHANGELOG.md

@@ -5,6 +5,32 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 
+## [5-r.1] - 2024-03-26
+
+### Added
+
+* Add function `mod()` to compute floating-point remainder in `CubismMath` class.
+
+### Changed
+
+* Change the weight value in `Expression` from `CubismExpressionMotion` to have it in the `CubismExpressionMotionManager`.
+* Reorganize the names of some functions and variables.
+  * This is a change that depends on fixing `eslintrc.yml`.
+* Change to output log if the argument `motionQueueEntry` is `null` in the `updateFadeWeight()` function of the `ACubismMotion` class.
+
+### Fixed
+
+* Fix `eslintrc.yml` to conform to the exact wording.
+
+### Deprecated
+
+* Deprecate the `_fadeWeight` variable and the `getFadeWeight()` function of the `CubismExpressionMotion` class.
+  * The `_fadeWeight` variable of the `CubismExpressionMotion` class can cause problems.
+  * Please use the `getFadeWeight()` function of the `CubismExpressionMotionManager` class with one argument from now on.
+* The `startMotion()` function of the `CubismMotionQueueManager` class with the unnecessary third argument `userTimeSeconds` is deprecated.
+  * Please use the `startMotion()` function with one arguments from now on.
+
+
 ## [5-r.1-beta.4] - 2024-01-18
 
 ### Changed
@@ -230,6 +256,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 * Reformat code using Prettier and ESLint.
 
 
+[5-r.1]: https://github.com/Live2D/CubismWebFramework/compare/5-r.1-beta.4...5-r.1
 [5-r.1-beta.4]: https://github.com/Live2D/CubismWebFramework/compare/5-r.1-beta.3...5-r.1-beta.4
 [5-r.1-beta.3]: https://github.com/Live2D/CubismWebFramework/compare/5-r.1-beta.2...5-r.1-beta.3
 [5-r.1-beta.2]: https://github.com/Live2D/CubismWebFramework/compare/5-r.1-beta.1...5-r.1-beta.2

README.ja.md

@@ -30,13 +30,13 @@ Cubism 5 Editorに搭載された新機能のSDK対応については [こちら
 
 ### Node.js
 
-* 21.5.0
-* 20.11.0
+* 21.7.1
+* 20.11.1
 
 
 ### TypeScript
 
-5.3.3
+5.4.2
 
 
 ## 開発環境構築
@@ -153,7 +153,7 @@ JSONパーサーやログ出力などのユーティリティ機能を提供し
 
 ### フォークとプルリクエスト
 
-修正、改善、さらには新機能をもたらすかどうかにかかわらず、プルリクエストに感謝します。ただし、ラッパーは可能な限り軽量で浅くなるように設計されているため、バグ修正とメモリ/パフォーマンスの改善のみを行う必要があることに注意してください。メインリポジトリを可能な限りクリーンに保つために、必要に応じて個人用フォークと機能ブランチを作成してください。
+修正、改善、さらには新機能をもたらすかどうかにかかわらず、プルリクエストに感謝します。メインリポジトリを可能な限りクリーンに保つために、必要に応じて個人用フォークと機能ブランチを作成してください。
 
 ### バグ
 

README.md

@@ -30,13 +30,13 @@ For compatibility with previous versions of Cubism SDK, please refer to [here](h
 
 ### Node.js
 
-* 21.5.0
-* 20.11.0
+* 21.7.1
+* 20.11.1
 
 
 ### TypeScript
 
-5.3.3
+5.4.2
 
 
 ## Development environment construction
@@ -153,7 +153,7 @@ There are many ways to contribute to the project: logging bugs, submitting pull
 
 ### Forking And Pull Requests
 
-We very much appreciate your pull requests, whether they bring fixes, improvements, or even new features. Note, however, that the wrapper is designed to be as lightweight and shallow as possible and should therefore only be subject to bug fixes and memory/performance improvements. To keep the main repository as clean as possible, create a personal fork and feature branches there as needed.
+We very much appreciate your pull requests, whether they bring fixes, improvements, or even new features. To keep the main repository as clean as possible, create a personal fork and feature branches there as needed.
 
 ### Bugs