Browse Source

push

tags/1.0.6
peter 3 years ago
parent
commit
25510c9800
8 changed files with 3 additions and 303 deletions
  1. 1
    0
      .gitignore
  2. 0
    12
      docs/README.md
  3. 0
    109
      docs/classes/_git_.updater.md
  4. 0
    11
      docs/globals.md
  5. 0
    9
      docs/modules/_git_.md
  6. 0
    134
      docs/modules/_types_.md
  7. 0
    26
      docs/modules/_utils_.md
  8. 2
    2
      package.json

+ 1
- 0
.gitignore View File

@@ -1,5 +1,6 @@
1 1
 node_modules
2 2
 js
3
+docs
3 4
 
4 5
 src/**/*.js
5 6
 src/**/*.d.ts

+ 0
- 12
docs/README.md View File

@@ -1,12 +0,0 @@
1
-[upgiter](README.md) › [Globals](globals.md)
2
-
3
-# upgiter
4
-
5
-# About
6
-
7
-# How to install
8
-
9
-# Quickstart
10
-
11
-# Documentation
12
-[https://gitea.frontblock.me/fw-vendor/upgiter/src/branch/master/docs/globals.md]

+ 0
- 109
docs/classes/_git_.updater.md View File

@@ -1,109 +0,0 @@
1
-[upgiter](../README.md) › [Globals](../globals.md) › ["Git"](../modules/_git_.md) › [Updater](_git_.updater.md)
2
-
3
-# Class: Updater
4
-
5
-## Hierarchy
6
-
7
-* **Updater**
8
-
9
-## Index
10
-
11
-### Constructors
12
-
13
-* [constructor](_git_.updater.md#constructor)
14
-
15
-### Properties
16
-
17
-* [conf](_git_.updater.md#private-conf)
18
-* [repo](_git_.updater.md#private-repo)
19
-
20
-### Methods
21
-
22
-* [checkoutTag](_git_.updater.md#checkouttag)
23
-* [cloneRepo](_git_.updater.md#clonerepo)
24
-* [getStatus](_git_.updater.md#getstatus)
25
-* [isOutdated](_git_.updater.md#isoutdated)
26
-
27
-## Constructors
28
-
29
-###  constructor
30
-
31
-\+ **new Updater**(`conf`: T.Conf): *[Updater](_git_.updater.md)*
32
-
33
-Defined in Git.ts:9
34
-
35
-**Parameters:**
36
-
37
-Name | Type |
38
------- | ------ |
39
-`conf` | T.Conf |
40
-
41
-**Returns:** *[Updater](_git_.updater.md)*
42
-
43
-## Properties
44
-
45
-### `Private` conf
46
-
47
-• **conf**: *T.Conf*
48
-
49
-Defined in Git.ts:10
50
-
51
-___
52
-
53
-### `Private` repo
54
-
55
-• **repo**: *U.git.SimpleGit*
56
-
57
-Defined in Git.ts:9
58
-
59
-## Methods
60
-
61
-###  checkoutTag
62
-
63
-▸ **checkoutTag**(`tag`: string): *Promise‹T.FolderStatus›*
64
-
65
-Defined in Git.ts:94
66
-
67
-**Parameters:**
68
-
69
-Name | Type |
70
------- | ------ |
71
-`tag` | string |
72
-
73
-**Returns:** *Promise‹T.FolderStatus›*
74
-
75
-___
76
-
77
-###  cloneRepo
78
-
79
-▸ **cloneRepo**(`force`: boolean): *Promise‹T.FolderStatus›*
80
-
81
-Defined in Git.ts:12
82
-
83
-**Parameters:**
84
-
85
-Name | Type | Default |
86
------- | ------ | ------ |
87
-`force` | boolean | false |
88
-
89
-**Returns:** *Promise‹T.FolderStatus›*
90
-
91
-___
92
-
93
-###  getStatus
94
-
95
-▸ **getStatus**(): *Promise‹T.FolderStatus›*
96
-
97
-Defined in Git.ts:50
98
-
99
-**Returns:** *Promise‹T.FolderStatus›*
100
-
101
-___
102
-
103
-###  isOutdated
104
-
105
-▸ **isOutdated**(): *Promise‹boolean›*
106
-
107
-Defined in Git.ts:104
108
-
109
-**Returns:** *Promise‹boolean›*

+ 0
- 11
docs/globals.md View File

@@ -1,11 +0,0 @@
1
-[upgiter](README.md) › [Globals](globals.md)
2
-
3
-# upgiter
4
-
5
-## Index
6
-
7
-### External modules
8
-
9
-* ["Git"](modules/_git_.md)
10
-* ["Types"](modules/_types_.md)
11
-* ["Utils"](modules/_utils_.md)

+ 0
- 9
docs/modules/_git_.md View File

@@ -1,9 +0,0 @@
1
-[upgiter](../README.md) › [Globals](../globals.md) › ["Git"](_git_.md)
2
-
3
-# External module: "Git"
4
-
5
-## Index
6
-
7
-### Classes
8
-
9
-* [Updater](../classes/_git_.updater.md)

+ 0
- 134
docs/modules/_types_.md View File

@@ -1,134 +0,0 @@
1
-[upgiter](../README.md) › [Globals](../globals.md) › ["Types"](_types_.md)
2
-
3
-# External module: "Types"
4
-
5
-## Index
6
-
7
-### Type aliases
8
-
9
-* [CommonConf](_types_.md#commonconf)
10
-* [Conf](_types_.md#conf)
11
-* [Credentials](_types_.md#credentials)
12
-* [FolderStatus](_types_.md#folderstatus)
13
-* [HTTPConf](_types_.md#httpconf)
14
-* [HTTPSConf](_types_.md#httpsconf)
15
-* [LocalConf](_types_.md#localconf)
16
-* [RemoteConf](_types_.md#remoteconf)
17
-* [SSHConf](_types_.md#sshconf)
18
-* [Schema](_types_.md#schema)
19
-
20
-## Type aliases
21
-
22
-###  CommonConf
23
-
24
-Ƭ **CommonConf**: *[LocalConf](_types_.md#localconf) & [RemoteConf](_types_.md#remoteconf)*
25
-
26
-Defined in Types.ts:37
27
-
28
-___
29
-
30
-###  Conf
31
-
32
-Ƭ **Conf**: *[HTTPConf](_types_.md#httpconf) | [HTTPSConf](_types_.md#httpsconf) | [SSHConf](_types_.md#sshconf)*
33
-
34
-Defined in Types.ts:13
35
-
36
-___
37
-
38
-###  Credentials
39
-
40
-Ƭ **Credentials**: *object*
41
-
42
-Defined in Types.ts:22
43
-
44
-#### Type declaration:
45
-
46
-* **credentials**? : *undefined | object*
47
-
48
-___
49
-
50
-###  FolderStatus
51
-
52
-Ƭ **FolderStatus**: *object*
53
-
54
-Defined in Types.ts:3
55
-
56
-#### Type declaration:
57
-
58
-* **currentTag**? : *undefined | string*
59
-
60
-* **empty**: *boolean*
61
-
62
-* **exists**: *boolean*
63
-
64
-* **isRepo**: *boolean*
65
-
66
-* **latestTag**? : *undefined | string*
67
-
68
-* **remote**? : *undefined | string*
69
-
70
-* **tags**? : *string[]*
71
-
72
-___
73
-
74
-###  HTTPConf
75
-
76
-Ƭ **HTTPConf**: *[CommonConf](_types_.md#commonconf) & [Credentials](_types_.md#credentials) & object*
77
-
78
-Defined in Types.ts:39
79
-
80
-___
81
-
82
-###  HTTPSConf
83
-
84
-Ƭ **HTTPSConf**: *[CommonConf](_types_.md#commonconf) & [Credentials](_types_.md#credentials) & object*
85
-
86
-Defined in Types.ts:46
87
-
88
-___
89
-
90
-###  LocalConf
91
-
92
-Ƭ **LocalConf**: *object*
93
-
94
-Defined in Types.ts:17
95
-
96
-#### Type declaration:
97
-
98
-* **localPath**: *string*
99
-
100
-___
101
-
102
-###  RemoteConf
103
-
104
-Ƭ **RemoteConf**: *object*
105
-
106
-Defined in Types.ts:29
107
-
108
-#### Type declaration:
109
-
110
-* **remoteHost**: *string*
111
-
112
-* **remotePath**: *string*
113
-
114
-* **remotePort**? : *undefined | number*
115
-
116
-* **repoName**: *string*
117
-
118
-* **schema**: *[Schema](_types_.md#schema)*
119
-
120
-___
121
-
122
-###  SSHConf
123
-
124
-Ƭ **SSHConf**: *[CommonConf](_types_.md#commonconf) & object*
125
-
126
-Defined in Types.ts:53
127
-
128
-___
129
-
130
-###  Schema
131
-
132
-Ƭ **Schema**: *"http" | "https" | "ssh"*
133
-
134
-Defined in Types.ts:15

+ 0
- 26
docs/modules/_utils_.md View File

@@ -1,26 +0,0 @@
1
-[upgiter](../README.md) › [Globals](../globals.md) › ["Utils"](_utils_.md)
2
-
3
-# External module: "Utils"
4
-
5
-## Index
6
-
7
-### Functions
8
-
9
-* [rmrf](_utils_.md#const-rmrf)
10
-
11
-## Functions
12
-
13
-### `Const` rmrf
14
-
15
-▸ **rmrf**(`path`: string, `options`: object): *Promise‹unknown›*
16
-
17
-Defined in Utils.ts:10
18
-
19
-**Parameters:**
20
-
21
-Name | Type | Default |
22
------- | ------ | ------ |
23
-`path` | string | - |
24
-`options` | object |  {} |
25
-
26
-**Returns:** *Promise‹unknown›*

+ 2
- 2
package.json View File

@@ -6,9 +6,9 @@
6 6
   "scripts": {
7 7
     "tsc": "tsc",
8 8
     "build": "npm run clean && tsc",
9
-    "clean": "rm -rf js",
9
+    "clean": "rm -rf js docs",
10 10
     "test": "mocha js/test/TestGitUpdater.js",
11
-    "docs": "typedoc --out docs ./src --readme ./README.md --plugin typedoc-plugin-markdown "
11
+    "docs": "typedoc --out docs ./src --readme ./README.md --plugin typedoc-plugin-markdown --mode file --hideBreadcrumbs"
12 12
   },
13 13
   "repository": {
14 14
     "type": "git",

Loading…
Cancel
Save