Merge pull request #16 from tkskto/feature/add-staged

Feature/add staged

Author: tkskto

.github/workflows/ci.yml

@@ -21,7 +21,7 @@ jobs:
       uses: actions/setup-node@v2
       with:
         node-version: ${{ matrix.node-version }}
-    - run: npm install
+    - run: npm ci
     - run: npm run build --if-present
     - run: npm run test:ci
       env:

README.md

@@ -42,8 +42,12 @@ See the [types](./types/index.d.ts) for details.
 
 #### branches.local: string[]
 
+Get the list of local.
+
 #### branches.remote: Record<string, string[]>
 
+Get the list of branches along with the remote name.
+
 ### Commit
 
 #### `Commit.author`: [Pick<Author, 'email' | 'name'>](#Author)
@@ -54,11 +58,15 @@ See the [types](./types/index.d.ts) for details.
 
 #### `Commit.parent`: string[]
 
+Hash of the parent commit. The merge commit has two parents.
+
 #### `Commit.files`: [File](#File)[]
 
+The list of files included in this commit.
+
 ### File
 
-#### `File.type`: 'add' | 'modify' | 'delete'
+#### `File.type`: 'added' | 'deleted' | 'ignored' | 'modified' | 'renamed' | 'unmodified' | 'untracked'
 
 #### `File.fileName`: string
 
@@ -186,6 +194,22 @@ Get remote info with `git remote -v` command.
 
 *   [Remote](#Remote)
 
+### status()
+
+Get the list of changed file with `git status -s` command.
+
+#### Since
+
+0.5.0
+
+#### Arguments
+
+*   nothing
+
+#### Returns
+
+*   [File](#File)
+
 ### tags()
 
 Get tag info with `git show-ref --tags` command.

__tests__/spec/branches.ts

@@ -2,7 +2,7 @@ import {branches} from '../../src';
 
 const isCI = process.argv[2] === '--ci';
 
-describe('branch test', () => {
+describe('branches test', () => {
   test('local', async () => {
     const branch = await branches(false);
 

__tests__/spec/commits.ts

@@ -68,11 +68,11 @@ describe('commits test', () => {
         files: [
           {
             fileName: 'LICENSE',
-            type: 'add',
+            type: 'added',
           },
           {
             fileName: 'README.md',
-            type: 'add',
+            type: 'added',
           },
         ]
       });

__tests__/spec/remotes.ts

@@ -2,7 +2,7 @@ import {remotes} from '../../src';
 
 const isCI = process.argv[2] === '--ci';
 
-describe('authors test', () => {
+describe('remotes test', () => {
   test('default', async () => {
     const remote = await remotes();
 

__tests__/spec/status.ts

@@ -0,0 +1,15 @@
+import {status} from '../../src';
+
+const isCI = process.argv[2] === '--ci';
+
+describe('status test', () => {
+  test('default', async () => {
+    const state = await status();
+
+    if (isCI) {
+      expect(state).toStrictEqual([]);
+    } else {
+      expect(state).toStrictEqual([]);
+    }
+  });
+});

__tests__/spec/tags.ts

@@ -2,20 +2,18 @@ import {tags} from '../../src';
 
 const isCI = process.argv[2] === '--ci';
 
-describe('authors test', () => {
+describe('tags test', () => {
   test('default', async () => {
     const tag = await tags();
 
     if (isCI) {
       expect(tag).toStrictEqual([]);
     } else {
-      expect(tag).toStrictEqual([
-        { hash: '24c2a9e90836d3eb13693099568408dca476b5cc', name: 'v0.1.0' },
-        { hash: 'ca0c3b48f237d820b0cc9ef87bbed16de2a1cf5f', name: 'v0.1.1' },
-        { hash: '41348ee32aadb9405f1555cbdae2ac3fdb8595b8', name: 'v0.2.0' },
-        { hash: '81c1d84d22d4d0b3ace5c1652d8ba37b8bcb2844', name: 'v0.3.0' },
-        { hash: 'fa5acd4263a4a527557414764f4f823464a8f509', name: 'v0.3.1' }
-      ]);
+      expect(tag).toContainEqual({ hash: '24c2a9e90836d3eb13693099568408dca476b5cc', name: 'v0.1.0' });
+      expect(tag).toContainEqual({ hash: 'ca0c3b48f237d820b0cc9ef87bbed16de2a1cf5f', name: 'v0.1.1' });
+      expect(tag).toContainEqual({ hash: '41348ee32aadb9405f1555cbdae2ac3fdb8595b8', name: 'v0.2.0' });
+      expect(tag).toContainEqual({ hash: '81c1d84d22d4d0b3ace5c1652d8ba37b8bcb2844', name: 'v0.3.0' });
+      expect(tag).toContainEqual({ hash: 'fa5acd4263a4a527557414764f4f823464a8f509', name: 'v0.3.1' });
     }
   });
 });