Adwaith Rao пре 4 година
родитељ
комит
ef00d282a1
6 измењених фајлова са 123 додато и 2 уклоњено
  1. +3
    -0
      .gitignore
  2. +12
    -2
      README.md
  3. +20
    -0
      package.json
  4. +14
    -0
      src/index.html
  5. +3
    -0
      src/scripts/script.ts
  6. +71
    -0
      tsconfig.json

+ 3
- 0
.gitignore Прегледај датотеку

@@ -0,0 +1,3 @@
node_modules/
.vscode/
src/**/*.js

+ 12
- 2
README.md Прегледај датотеку

@@ -1,3 +1,13 @@
# basic-html-with-typescript-boilerplate
# Basic HTML with typescript boilerplate
A starting project to set up an HTML site set up with typescript

A starting project to set up an HTML site set up with typescript
### Initialize
- Make sure the latest NodeJS is installed (v12.18.3 at the time of this commit).
- Make sure that npm is up to date (v7.5.4 at the time of this commit).
- Run ```npm i``` to install all dependencies.

### Usage
- Make your preferred directory structure under the **src/** folder.
- Run ```npm run watch``` from your command prompt or terminal. This keeps the Typescript compiler running in watch mode.
- Wait for incremental compilation. Any file with a **.ts** extension is compiled into an equivalent **.js** file within the same directory.
- Link the js file to your HTML with its ```<script>``` tag.

+ 20
- 0
package.json Прегледај датотеку

@@ -0,0 +1,20 @@
{
"name": "basic-html-with-typescript-boilerplate",
"version": "1.0.0",
"description": "A starting project to set up an HTML site set up with Typescript",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1",
"watch": "tsc -w"
},
"repository": {
"type": "git",
"url": "git@code.webtrigon.com:adwaith/basic-html-with-typescript-boilerplate.git"
},
"author": "Adwaith Rao P, Webtrigon Technologies Pvt. Ltd.",
"license": "MIT",
"devDependencies": {
"tslint": "^6.1.3",
"typescript": "^4.2.4"
}
}

+ 14
- 0
src/index.html Прегледај датотеку

@@ -0,0 +1,14 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Typescript boilerplate setup</title>
</head>
<body>
<h1>Basic setup for Typescript usage with normal HTML files</h1>
<p>Open the console to see a console message written via typescript</p>
<script src="./scripts/script.js"></script>
</body>
</html>

+ 3
- 0
src/scripts/script.ts Прегледај датотеку

@@ -0,0 +1,3 @@
document.addEventListener('DOMContentLoaded', function () {
console.log('The JS file is loaded into the DOM');
});

+ 71
- 0
tsconfig.json Прегледај датотеку

@@ -0,0 +1,71 @@
{
"compilerOptions": {
/* Visit https://aka.ms/tsconfig.json to read more about this file */

/* Basic Options */
// "incremental": true, /* Enable incremental compilation */
"target": "es5", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
"module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
"lib": ["dom", "dom.iterable", "esnext"], /* Specify library files to be included in the compilation. */
// "allowJs": true, /* Allow javascript files to be compiled. */
// "checkJs": true, /* Report errors in .js files. */
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', 'react', 'react-jsx' or 'react-jsxdev'. */
// "declaration": true, /* Generates corresponding '.d.ts' file. */
// "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
// "sourceMap": true, /* Generates corresponding '.map' file. */
// "outFile": "./", /* Concatenate and emit output to single file. */
// "outDir": "./", /* Redirect output structure to the directory. */
// "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
// "composite": true, /* Enable project compilation */
// "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
// "removeComments": true, /* Do not emit comments to output. */
// "noEmit": true, /* Do not emit outputs. */
"importHelpers": true, /* Import emit helpers from 'tslib'. */
"downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */

/* Strict Type-Checking Options */
"strict": true, /* Enable all strict type-checking options. */
// "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* Enable strict null checks. */
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
// "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */

/* Additional Checks */
// "noUnusedLocals": true, /* Report errors on unused locals. */
// "noUnusedParameters": true, /* Report errors on unused parameters. */
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
// "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */
// "noPropertyAccessFromIndexSignature": true, /* Require undeclared properties from index signatures to use element accesses. */

/* Module Resolution Options */
// "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
// "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
// "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
// "typeRoots": [], /* List of folders to include type definitions from. */
// "types": [], /* Type declaration files to be included in compilation. */
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
"esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */

/* Source Map Options */
"sourceRoot": "src/", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
"inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */

/* Experimental Options */
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */

/* Advanced Options */
"skipLibCheck": true, /* Skip type checking of declaration files. */
"forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
}
}

Loading…
Откажи
Сачувај