Skip to content

Commit 4d59a14

Browse files
committed
optimize package size
Signed-off-by: Qingpeng Li <qingpeng9802@gmail.com>
1 parent c06fe1a commit 4d59a14

File tree

10 files changed

+25
-32
lines changed

10 files changed

+25
-32
lines changed

.vscodeignore

Lines changed: 16 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,21 @@
1-
# vscode
2-
.vscode/**
3-
.vscode-test/**
4-
.vscode-test-web/**
5-
vsc-extension-quickstart.md
6-
*.vsix
1+
# Ignore everything
2+
*
3+
*/**
74

8-
# git
9-
.gitignore
10-
.github/**
5+
# Whitelist
6+
!package.json
117

12-
# node
13-
src/**
14-
out/**
15-
node_modules/**
16-
webpack.config.js
17-
**/tsconfig.json
18-
**/.eslintrc.json
19-
**/*.map
20-
**/*.ts
21-
*.log
8+
!dist/web/extension.js
229

23-
# dev
24-
assets/**
25-
scripts/**
26-
.parcel-cache
10+
!images/commonlisp_file_icon.svg
11+
!images/icon.png
2712

28-
# prod
13+
!syntaxes/commonlisp.tmLanguage.json
14+
!syntaxes/cl_codeblock.tmLanguage.json
2915

16+
!language-configuration.json
17+
!snippets/commonlisp_snippets.json
18+
19+
!README.md
20+
!CHANGELOG.md
21+
!LICENSE

CONTRIBUTING.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,18 @@ Hoping this guide will be helpful to you whether you would like to contribute, f
77
## Architecture
88
Let us first take a brief look at the design of this project.
99

10-
![layers](./images/layers.png)
10+
![layers](./images/doc/layers.png)
1111

1212
The image above shows the layers of the source code. `entry` initializes the extension and applies the vscode workspace configuration to the extension. `provider_interface` registers the providers in vscode. `builders` prepare the data structures from the raw text string/processed semantic information for vscode language features. `collect_info` collects the semantic information from the raw text string. `common` includes some constants and algorithms. `doc` is the interface for getting documentation.
1313

14-
If you are interested in a more detailed dependency graph, you can find the dependency graph in [`./images/dependency_graph.svg`](./images/dependency_graph.svg). Also, you can generate the dependency graph by running
14+
If you are interested in a more detailed dependency graph, you can find the dependency graph in [`./images/doc/dependency_graph.svg`](./images/doc/dependency_graph.svg). Also, you can generate the dependency graph by running
1515
> You may need to run `sudo apt install graphviz` first
1616
```shell
17-
npx depcruise src --no-config --include-only "^src" --output-type dot | dot -T svg > ./images/dependency_graph.svg
17+
npx depcruise src --no-config --include-only "^src" --output-type dot | dot -T svg > ./images/doc/dependency_graph.svg
1818
```
1919

2020
## Data Flow
21-
![data_flow](./images/data_flow.svg)
21+
![data_flow](./images/doc/data_flow.svg)
2222

2323
Please do not trust the correspondence between naming in the data flow diagram and naming in the source code since the naming in the source code is subject to change.
2424

@@ -86,6 +86,7 @@ Run `npm i -g @vscode/vsce` to install `vsce` globally since `vsce` is not in th
8686

8787
Run `vsce package`.
8888
Then, you will get a `common-lisp-x.x.x.vsix` in your `./` .
89+
> `.vscodeignore` uses whitelist mode. Run `npx vsce ls` to check what has been packaged.
8990
9091
If you would like to use the packaged `.vsix` extension, you can load the `.vsix` extension to vscode by referring to [extension-marketplace install-from-a-vsix](https://code.visualstudio.com/docs/editor/extension-marketplace#_install-from-a-vsix).
9192

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ This VS Code extension supports Syntax Highlighting, Snippets, Completion, Hover
44
## Features
55

66
### Syntax Highlighting
7-
<img src="https://raw.githubusercontent.com/qingpeng9802/vscode-common-lisp/master/images/syntax_dark_plus.png">
7+
<img src="https://raw.githubusercontent.com/qingpeng9802/vscode-common-lisp/master/images/doc/syntax_dark_plus.png">
88

9-
<img src="https://raw.githubusercontent.com/qingpeng9802/vscode-common-lisp/master/images/syntax_light_plus.png">
9+
<img src="https://raw.githubusercontent.com/qingpeng9802/vscode-common-lisp/master/images/doc/syntax_light_plus.png">
1010

1111
### Snippets
12-
<img src="https://raw.githubusercontent.com/qingpeng9802/vscode-common-lisp/master/images/snippets.gif">
12+
<img src="https://raw.githubusercontent.com/qingpeng9802/vscode-common-lisp/master/images/doc/snippets.gif">
1313

1414
## Usage and Recommendation
1515
Beginner's Guide: [Overview](https://code.visualstudio.com/docs/languages/overview).
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,7 @@
270270
}
271271
}
272272
},
273-
"icon": "images/icon.png",
273+
"icon": "./images/icon.png",
274274
"repository": {
275275
"type": "git",
276276
"url": "https://github.com/qingpeng9802/vscode-common-lisp.git"

0 commit comments

Comments
 (0)