Skip to content

Commit 6632773

Browse files
committed
Update docs
1 parent 31bc614 commit 6632773

File tree

4 files changed

+13
-61
lines changed

4 files changed

+13
-61
lines changed

.spaghetti-cutter.hjson

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,16 @@
11
{
2-
tool: ["x/*", "data"],
2+
tool: ["x/*"],
33

44
size: 1024
55

66
allowAdditionally: {
77
// package parse is allowed in API tests
88
// so we can test with real source code
99
"*_test": ["parse"]
10-
11-
// the central data structures are filled with configuration data
12-
"x/config": ["data"]
1310
}
1411

1512
// document and restrict usage of external packages
1613
allowOnlyIn: {
17-
"github.com/hjson/**": ["x/config"]
1814
"golang.org/x/tools**": ["parse*", "x/pkgs*"]
1915
}
2016
}

dirtree.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,9 @@
11
spaghetti-analyzer - Package spaghetti-analyzer ...
2-
├── data - Package data ...
32
├── deps - Package deps ...
43
├── doc - Package doc ...
54
├── parse - Package parse ...
65
├── stat - Package stat ...
76
├── tree - Package tree contains the logic for creating a directory tree with information about the Go packages in it.
87
└── x -
9-
├── config - Package config ...
108
├── dirs - Package dirs ...
119
└── pkgs - Package pkgs ...

package_dependencies.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,11 @@
11
# Dependency Table For: github.com/flowdev/spaghetti-analyzer
22

3-
| | d a t a - T | d e p s - S | d o c - S | p a r s e - S | s t a t - S | t r e e - S | x / c o n f i g - T | x / d i r s - T | x / p k g s - T |
4-
| :- | :- | :- | :- | :- | :- | :- | :- | :- | :- |
5-
| **/** | **T** | **S** | **S** | **S** | **S** | **S** | **T** | **T** | **T** |
6-
| deps | T | | | | | | T | | T |
7-
| doc | T | | | | | | | | |
8-
| parse | | | | | | | | | T |
9-
| stat | T | | | | | | | | |
10-
| tree | | | | | | | | | T |
11-
| _x/config_ | _T_ | | | | | | | | |
3+
| | d e p s - S | d o c - S | p a r s e - S | s t a t - S | t r e e - S | x / d i r s - T | x / p k g s - T |
4+
| :- | :- | :- | :- | :- | :- | :- | :- |
5+
| **/** | **S** | **S** | **S** | **S** | **S** | **T** | **T** |
6+
| deps | | | | | | | T |
7+
| parse | | | | | | | T |
8+
| tree | | | | | | | T |
129

1310
### Legend
1411

package_statistics.md

Lines changed: 6 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,10 @@
22

33
| package | type | direct deps | all deps | users | max score | min score |
44
| :- | :-: | -: | -: | -: | -: | -: |
5-
| [/](#root-package) | [ \[G\] ](#legend) | [9](#direct-dependencies-imports-of-root-package) | [9](#all-including-transitive-dependencies-imports-of-root-package) | 0 | 0 | 0 |
6-
| [deps](#package-deps) | [ \[S\] ](#legend) | [3](#direct-dependencies-imports-of-package-deps) | [3](#all-including-transitive-dependencies-imports-of-package-deps) | [1](#packages-using-importing-package-deps) | 0 | 0 |
7-
| [doc](#package-doc) | [ \[S\] ](#legend) | [1](#direct-dependencies-imports-of-package-doc) | [1](#all-including-transitive-dependencies-imports-of-package-doc) | [1](#packages-using-importing-package-doc) | 0 | 0 |
5+
| [/](#root-package) | [ \[G\] ](#legend) | [7](#direct-dependencies-imports-of-root-package) | [7](#all-including-transitive-dependencies-imports-of-root-package) | 0 | 0 | 0 |
6+
| [deps](#package-deps) | [ \[S\] ](#legend) | [1](#direct-dependencies-imports-of-package-deps) | [1](#all-including-transitive-dependencies-imports-of-package-deps) | [1](#packages-using-importing-package-deps) | 0 | 0 |
87
| [parse](#package-parse) | [ \[S\] ](#legend) | [1](#direct-dependencies-imports-of-package-parse) | [1](#all-including-transitive-dependencies-imports-of-package-parse) | [1](#packages-using-importing-package-parse) | 0 | 0 |
9-
| [stat](#package-stat) | [ \[S\] ](#legend) | [1](#direct-dependencies-imports-of-package-stat) | [1](#all-including-transitive-dependencies-imports-of-package-stat) | [1](#packages-using-importing-package-stat) | 0 | 0 |
108
| [tree](#package-tree) | [ \[S\] ](#legend) | [1](#direct-dependencies-imports-of-package-tree) | [1](#all-including-transitive-dependencies-imports-of-package-tree) | [1](#packages-using-importing-package-tree) | 0 | 0 |
11-
| [x/config](#package-xconfig) | [ \[T\] ](#legend) | [1](#direct-dependencies-imports-of-package-xconfig) | [1](#all-including-transitive-dependencies-imports-of-package-xconfig) | [2](#packages-using-importing-package-xconfig) | 0 | 0 |
129

1310
### Legend
1411

@@ -29,35 +26,23 @@
2926

3027

3128
#### Direct Dependencies (Imports) Of Root Package
32-
`data`, [deps](#package-deps), [doc](#package-doc), [parse](#package-parse), [stat](#package-stat), [tree](#package-tree), [x/config](#package-xconfig), `x/dirs`, `x/pkgs`
29+
[deps](#package-deps), `doc`, [parse](#package-parse), `stat`, [tree](#package-tree), `x/dirs`, `x/pkgs`
3330

3431
#### All (Including Transitive) Dependencies (Imports) Of Root Package
35-
`data`, [deps](#package-deps), [doc](#package-doc), [parse](#package-parse), [stat](#package-stat), [tree](#package-tree), [x/config](#package-xconfig), `x/dirs`, `x/pkgs`
32+
[deps](#package-deps), `doc`, [parse](#package-parse), `stat`, [tree](#package-tree), `x/dirs`, `x/pkgs`
3633

3734
### Package deps
3835

3936

4037
#### Direct Dependencies (Imports) Of Package deps
41-
`data`, [x/config](#package-xconfig), `x/pkgs`
38+
`x/pkgs`
4239

4340
#### All (Including Transitive) Dependencies (Imports) Of Package deps
44-
`data`, [x/config](#package-xconfig), `x/pkgs`
41+
`x/pkgs`
4542

4643
#### Packages Using (Importing) Package deps
4744
[root](#root-package)
4845

49-
### Package doc
50-
51-
52-
#### Direct Dependencies (Imports) Of Package doc
53-
`data`
54-
55-
#### All (Including Transitive) Dependencies (Imports) Of Package doc
56-
`data`
57-
58-
#### Packages Using (Importing) Package doc
59-
[root](#root-package)
60-
6146
### Package parse
6247

6348

@@ -70,18 +55,6 @@
7055
#### Packages Using (Importing) Package parse
7156
[root](#root-package)
7257

73-
### Package stat
74-
75-
76-
#### Direct Dependencies (Imports) Of Package stat
77-
`data`
78-
79-
#### All (Including Transitive) Dependencies (Imports) Of Package stat
80-
`data`
81-
82-
#### Packages Using (Importing) Package stat
83-
[root](#root-package)
84-
8558
### Package tree
8659

8760

@@ -93,15 +66,3 @@
9366

9467
#### Packages Using (Importing) Package tree
9568
[root](#root-package)
96-
97-
### Package x/config
98-
99-
100-
#### Direct Dependencies (Imports) Of Package x/config
101-
`data`
102-
103-
#### All (Including Transitive) Dependencies (Imports) Of Package x/config
104-
`data`
105-
106-
#### Packages Using (Importing) Package x/config
107-
[root](#root-package), [deps](#package-deps)

0 commit comments

Comments
 (0)