fix: delete unsupported options & cleanup the path and add comment (#19)

* fix: cleanup the path and comment

* fix: delete duplicated readme

* fix: clean up gitignore

* fix: delete unsupported option

* apply gitignore and release version 0.2.4

* chore: increase time limit of test

* fix:add gitignore

.gitignore

@@ -1,113 +1,19 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-lerna-debug.log*
-
-# Diagnostic reports (https://nodejs.org/api/report.html)
-report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
-
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-*.lcov
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-bower_components
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
-
 # Dependency directories
 node_modules/
-jspm_packages/
-
-# TypeScript v1 declaration files
-typings/
-
-# TypeScript cache
-*.tsbuildinfo
-
-# Optional npm cache directory
-.npm
 
-# Optional eslint cache
-.eslintcache
-
-# Microbundle cache
-.rpt2_cache/
-.rts2_cache_cjs/
-.rts2_cache_es/
-.rts2_cache_umd/
+# node-waf configuration
+.lock-wscript
 
 # Optional REPL history
 .node_repl_history
 
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# dotenv environment variables file
-.env
-.env.test
-
-# parcel-bundler cache (https://parceljs.org/)
-.cache
-
-# Next.js build output
-.next
-
-# Nuxt.js build / generate output
-.nuxt
-dist
-
-# Gatsby files
-.cache/
-# Comment in the public line in if your project uses Gatsby and *not* Next.js
-# https://nextjs.org/blog/next-9-1#public-directory-support
-# public
-
-# vuepress build output
-.vuepress/dist
-
-# Serverless directories
-.serverless/
-
-# FuseBox cache
-.fusebox/
-
-# DynamoDB Local files
-.dynamodb/
-
-# TernJS port file
-.tern-port
-
 # IDEs
 .vscode/
 .idea/
 
 # MacOS
 .DS_Store
 
-build/
+dist/
+build/
+doc/

README.md

@@ -78,4 +78,50 @@ async function readExample() {
     const decodedModule = await MoveBuilder.decode_module_bytes(binary);
     console.log(decodedModule)
 }
+```
+
+## Options
+
+For more details on the available options, refer to the [source code](src/types/options.ts).
+
+### BuildOptions
+The `BuildOptions` interface provides various options to customize the build process.
+
+```ts
+export interface BuildOptions {
+    devMode?: boolean
+    testMode?: boolean
+    generateDocs?: boolean
+    generateAbis?: boolean
+    installDir?: string
+    forceRecompilation?: boolean
+    fetchDepsOnly?: boolean
+    skipFetchLatestGitDeps?: boolean
+    bytecodeVersion?: number
+    compilerVersion?: string
+    languageVersion?: string
+    addtionalNamedAddresses?: [string, string][]
+}
+```
+
+### CleanOptions
+The `CleanOptions` interface provides options to clean the build artifacts.
+
+```ts
+export interface CleanOptions {
+    cleanCache?: boolean
+    cleanByProduct?: boolean
+}
+```
+
+### TestOptions
+The `TestOptions` interface provides options to customize the testing process.
+
+```ts
+export interface TestOptions {
+    filter?: string
+    reportStatistics?: boolean
+    reportStorageOnError?: boolean
+    ignoreCompileWarnings?: boolean
+}
 ```

jest.config.js

@@ -2,4 +2,9 @@ module.exports = {
   testEnvironment: 'node',
   preset: 'ts-jest',
   roots: ['<rootDir>/test'],
+  moduleNameMapper: {
+    '^builder': '<rootDir>/src/builder.ts',
+    '^types$': '<rootDir>/src/types',
+    '^lib$': '<rootDir>/src/lib',
+  }
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@initia/builder.js",
-  "version": "0.2.3",
+  "version": "0.2.4",
   "description": "The JavaScript Move Builder for Initia",
   "license": "MIT",
   "author": "Initia Foundation",
@@ -20,7 +20,7 @@
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "files": [
-    "dist",
+    "dist/src",
     "library"
   ],
   "engines": {