Merge pull request #20 from SinusBot/refactor

Refactor and fix tsd generation

Author: irgendwr

.gitignore

@@ -1,6 +1,5 @@
 # ignore built documentation files
-documentation/
+documentation
 out
 node_modules
-package-lock.json
-tsd/types.d.ts
+tsd

.npmignore

@@ -1,2 +1,12 @@
-!tsd/types.d.ts
-intellisense-demo.gif
+# keep tsd
+!tsd
+
+# ignore other stuff
+.git
+.gitignore
+.travis.yml
+documentation/
+config.json
+after_building.sed
+intellisense-demo.gif
+README.md

.travis.yml

@@ -3,12 +3,10 @@ node_js:
 - node
 script:
 - npm install -g documentation jsdoc
-- documentation build api.js -c documentation.yml
-  --project-name "SinusBot Scripting Engine" --project-version " "
+- documentation build api/ -c documentation.yml
+  --project-name "SinusBot Scripting Engine" --project-version " " --favicon "/favicon.ico"
   --shallow -f html -o documentation
-- sed -f after_building.sed -i documentation/index.html
 - jsdoc -c config.json || true
-- node generate.js
 - cp tsd/types.d.ts documentation
 deploy:
   - provider: pages

README.md

@@ -19,13 +19,13 @@ npm install -g documentation
 ### Generate html file
 
 ```bash
-documentation build api.js -c documentation.yml --project-name "SinusBot Scripting Engine" --project-version " " --shallow -f html -o documentation
+documentation build api/ -c documentation.yml --project-name "SinusBot Scripting Engine" --project-version " " --shallow -f html -o documentation
 ```
 
 ### Serve locally
 
 ```bash
-documentation serve api.js -c documentation.yml --project-name "SinusBot Scripting Engine" --project-version " " --shallow -w
+documentation serve api/ -c documentation.yml --project-name "SinusBot Scripting Engine" --project-version " " --shallow -w
 ```
 
 ## IntelliSense
@@ -38,27 +38,15 @@ There are TypeScript typings available which are generated out of the documentat
 
 First of all you need to install the typings by executing: `npm i sinusbot-scripting-engine` or `yarn add sinusbot-scripting-engine`.
 
-After you have the typings installed, you need to create a `jsconfig.json` with the following content:
+After you have the typings installed, you need to create a `jsconfig.json` in the folder where you develop your scripts with the following content:
 
 ```json
 {
     "compilerOptions": {
-        "target": "es5",
+        "target": "es5", // or "es2018" if sinusbot version >= 1.0.0
         "checkJs": true
     }
 }
 ```
 
-Or alternatively if you only want to enable type checking for specific files set the config to
-
-```json
-{
-    "compilerOptions": {
-        "target": "es5"
-    }
-}
-```
-
-and add `// @ts-check` as the first line of your script that should be checked.
-
 For reference, you can check out [this repository](https://github.com/SinusBot/scripts).