init

diff --git a/.gitignore b/.gitignore
new file mode 100644 (file)
index 0000000..de4d1f0
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,2 @@
+dist
+node_modules

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..16d12f0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# VueRouter
+
+## API
+
+### `Router`
+
+```js
+import { html5 as history, Router } from 'vue-router'
+
+const router = new Router({
+  history,
+})
+```
+
+```html
+<Router :history="html5">
+  <Route component="Home" path="/" name="home" />
+  <Route component="User" path="/users" name="user" />
+</Router>
+```
+
+```html
+<div class="user">
+  <Router>
+    <Route component="UserList" path="" name="list" />
+    <Route component="UserDetail" path=":id" name="detail" />
+    <Route component="UserNew" path="new" name="new" />
+    <Route component="UserEdit" path=":id/edit" name="edit" props/>
+  </Router>
+</div>
+```

diff --git a/package.json b/package.json
new file mode 100644 (file)
index 0000000..3018c52
--- /dev/null
+++ b/package.json
@@ -0,0 +1,12 @@
+{
+  "name": "vue-router",
+  "version": "1.0.0",
+  "main": "index.js",
+  "license": "MIT",
+  "devDependencies": {
+    "typescript": "^3.0.1"
+  },
+  "dependencies": {
+    "path-to-regexp": "^2.2.1"
+  }
+}

diff --git a/src/history/base.ts b/src/history/base.ts
new file mode 100644 (file)
index 0000000..7cd5ae6
--- /dev/null
+++ b/src/history/base.ts
@@ -0,0 +1,15 @@
+import { START, Location } from '../types/index'
+export interface NavigationCallback {
+  (location: string): void
+}
+
+export default abstract class BaseHistory {
+  // previousState: object
+  location: Location
+  abstract push(to: Location): void
+  abstract listen(callback: NavigationCallback): Function
+
+  constructor() {
+    this.location = START
+  }
+}

diff --git a/src/history/html5.ts b/src/history/html5.ts
new file mode 100644 (file)
index 0000000..edf0b31
--- /dev/null
+++ b/src/history/html5.ts
@@ -0,0 +1,26 @@
+import BaseHistory, { NavigationCallback } from './base'
+import { Location } from '../types/index'
+
+export default class HTML5History extends BaseHistory {
+  history: typeof window.history
+  constructor() {
+    super()
+    this.history = window.history
+  }
+
+  push(to: Location): void {
+    // TODO resolve url
+    this.history.pushState(
+      {
+        from: this.location,
+        to,
+      },
+      '',
+      to
+    )
+  }
+
+  listen(callback: NavigationCallback): Function {
+    return () => {}
+  }
+}

diff --git a/src/index.ts b/src/index.ts
new file mode 100644 (file)
index 0000000..8de295d
--- /dev/null
+++ b/src/index.ts
@@ -0,0 +1 @@
+class Router {}

diff --git a/src/types/index.ts b/src/types/index.ts
new file mode 100644 (file)
index 0000000..4376048
--- /dev/null
+++ b/src/types/index.ts
@@ -0,0 +1,29 @@
+type TODO = any
+
+type ParamsType = Record<string, string | string[]>
+
+interface PropsTransformer {
+  (params: ParamsType): any
+}
+
+// export interface Location<PT extends PropsTransformer> {
+//   record: RouteRecord<PT>
+//   path: string
+//   params: ReturnType<PT>
+// }
+
+// NOTE not sure the whole PropsTransformer thing can be usefull
+// since in callbacks we don't know where we are coming from
+// and I don't thin it's possible to filter out the route
+// by any means
+export interface RouteRecord<PT extends PropsTransformer> {
+  path: string | RegExp
+  component: TODO
+  name: string
+  props: PT
+}
+
+// TODO location should be an object
+export type Location = string
+
+export const START: Location = ''

diff --git a/tsconfig.json b/tsconfig.json
new file mode 100644 (file)
index 0000000..6d38549
--- /dev/null
+++ b/tsconfig.json
@@ -0,0 +1,60 @@
+{
+  "include": ["src/**/*.ts"],
+  "compilerOptions": {
+    /* Basic Options */
+    "target": "esnext" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */,
+    "module": "esnext" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */,
+    // "lib": ["es2017.object"] /* 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', or 'react'. */
+    // "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": "./dist" /* 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 */
+    // "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. */
+    // "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. */
+
+    /* 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. */
+
+    /* Source Map Options */
+    // "sourceRoot": "./",                    /* 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. */
+  }
+}

diff --git a/yarn.lock b/yarn.lock
new file mode 100644 (file)
index 0000000..b48f5a4
--- /dev/null
+++ b/yarn.lock
@@ -0,0 +1,11 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+
+path-to-regexp@^2.2.1:
+  version "2.2.1"
+  resolved "https://registry.yarnpkg.com/path-to-regexp/-/path-to-regexp-2.2.1.tgz#90b617025a16381a879bc82a38d4e8bdeb2bcf45"
+
+typescript@^3.0.1:
+  version "3.0.1"
+  resolved "https://registry.yarnpkg.com/typescript/-/typescript-3.0.1.tgz#43738f29585d3a87575520a4b93ab6026ef11fdb"