refactor(git)!: remove v8 deprecated git method (#2716)

faker-js · Mar 6, 2024 · b3afc8f · b3afc8f
1 parent 2716865
commit b3afc8f
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 23 deletions.
diff --git a/docs/guide/upgrading_v9/2716.md b/docs/guide/upgrading_v9/2716.md
@@ -0,0 +1,7 @@
+### Remove deprecated git method
+
+Removed deprecated git method
+
+| old                    | replacement                          |
+| ---------------------- | ------------------------------------ |
+| `faker.git.shortSha()` | `faker.git.commitSha({ length: 7 })` |
diff --git a/src/modules/git/index.ts b/src/modules/git/index.ts
@@ -1,4 +1,3 @@
-import { deprecated } from '../../internal/deprecated';
 import { ModuleBase } from '../../internal/module-base';
 
 const nbsp = '\u00A0';
@@ -196,6 +195,8 @@ export class GitModule extends ModuleBase {
    *
    * @example
    * faker.git.commitSha() // '2c6e3880fd94ddb7ef72d34e683cdc0c47bec6e6'
+   * faker.git.commitSha({ length: 7 }) // 'dbee57b'
+   * faker.git.commitSha({ length: 8 }) // '0e52376a'
    *
    * @since 5.0.0
    */
@@ -216,24 +217,4 @@ export class GitModule extends ModuleBase {
       prefix: '',
     });
   }
-
-  /**
-   * Generates a random commit sha (short).
-   *
-   * @example
-   * faker.git.shortSha() // '6155732'
-   *
-   * @since 5.0.0
-   *
-   * @deprecated Use `faker.git.commitSha({ length: 7 })` instead.
-   */
-  shortSha(): string {
-    deprecated({
-      deprecated: 'faker.git.shortSha()',
-      proposed: 'faker.git.commitSha({ length: 7 })',
-      since: '8.0',
-      until: '9.0',
-    });
-    return this.commitSha({ length: 7 });
-  }
 }
diff --git a/test/modules/git.spec.ts b/test/modules/git.spec.ts
@@ -18,8 +18,6 @@ describe('git', () => {
         .it('with length 8', { length: 8 });
     });
 
-    t.skip('shortSha');
-
     t.describeEach(
       'commitEntry',
       'commitDate'