init

egoist · egoist · commit fa5d6d860732 · 2019-01-28T22:05:51.000+08:00
diff --git a/.editorconfig b/.editorconfig
@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1 @@
+* text=auto
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,3 @@
+node_modules
+cache/
+dist/
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,5 @@
+{
+  "semi": false,
+  "singleQuote": true,
+  "bracketSpacing": true
+}
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) EGOIST <0x142857@gmail.com> (https://egoist.sh)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,86 @@
+<img src="https://user-images.githubusercontent.com/8784712/51839289-d122a380-2343-11e9-90b8-bc2756c5dee9.png" alt="logo">
+
+---
+
+[![NPM version](https://badgen.net/npm/v/import-http)](https://npmjs.com/package/import-http) [![NPM downloads](https://badgen.net/npm/dm/import-http)](https://npmjs.com/package/import-http) [![CircleCI](https://badgen.net/circleci/github/egoist/import-http/master)](https://circleci.com/gh/egoist/import-http/tree/master) [![donate](https://badgen.net/badge/support%20me/donate/ff69b4)](https://patreon.com/egoist) [![chat](https://badgen.net/badge/chat%20on/discord/7289DA)](https://chat.egoist.sh)
+
+**Please consider [donating](https://www.patreon.com/egoist) to this project's author, [EGOIST](#author), to show your ❤️ and support.**
+
+## Introduction
+
+- Imports source code URLs! Like `<script type="module">` and [Deno](https://github.com/denoland/deno) but implemented in webpack. Embracing the future :)
+
+  ```js
+  import template from 'https://unpkg.com/lodash/template'
+
+  console.log(template(`Hello <%= name %>`)({ name: 'EGOIST' }))
+  ```
+
+  Remote code is fetched and cached on first build, and never updated until
+  you use the `reload` option. See more about [Caching](#caching).
+
+- No more `node_modules` bloat, no dependency to install.
+
+![image](https://unpkg.com/@egoist/media/projects/import-http/preview.svg)
+
+## Install
+
+```bash
+yarn add import-http --dev
+```
+
+## Usage
+
+In your `webpack.config.js`:
+
+```js
+const ImportHttpPlugin = require('import-http')
+
+module.exports = {
+  plugins: [new ImportHttpPlugin()]
+}
+```
+
+That's it, try following code:
+
+```js
+import React from 'https://unpkg.com/react'
+import Vue from 'https://unpkg.com/vue'
+
+console.log(React, Vue)
+```
+
+Run webpack and it just works.
+
+## Caching
+
+Resources will be fetched at the very first build, then the response will be cached in `~/.import-http` dir. You can use the `reload` option to invalidate cache:
+
+```js
+const ImportHttpPlugin = require('import-http')
+
+module.exports = {
+  plugins: [
+    new ImportHttpPlugin({
+      reload: process.env.RELOAD
+    })
+  ]
+}
+```
+
+Then run `RELOAD=true webpack` to update cache.
+
+## Contributing
+
+1. Fork it!
+2. Create your feature branch: `git checkout -b my-new-feature`
+3. Commit your changes: `git commit -am 'Add some feature'`
+4. Push to the branch: `git push origin my-new-feature`
+5. Submit a pull request :D
+
+## Author
+
+**import-http** © EGOIST, Released under the [MIT](./LICENSE) License.<br>
+Authored and maintained by EGOIST with help from contributors ([list](https://github.com/egoist/import-http/contributors)).
+
+> [Website](https://egoist.sh) · GitHub [@EGOIST](https://github.com/egoist) · Twitter [@\_egoistlily](https://twitter.com/_egoistlily)
diff --git a/circle.yml b/circle.yml
@@ -0,0 +1,26 @@
+version: 2
+jobs:
+  build:
+    docker:
+      - image: circleci/node:latest
+    branches:
+      ignore:
+        - gh-pages # list of branches to ignore
+        - /release\/.*/ # or ignore regexes
+    steps:
+      - checkout
+      - restore_cache:
+          key: dependency-cache-{{ checksum "yarn.lock" }}
+      - run:
+          name: install dependences
+          command: yarn
+      - save_cache:
+          key: dependency-cache-{{ checksum "yarn.lock" }}
+          paths:
+            - ./node_modules
+      - run:
+          name: test
+          command: yarn test
+      - run:
+          name: release
+          command: yarn semantic-release
diff --git a/example/foo.js b/example/foo.js
@@ -0,0 +1,3 @@
+export default 'foo'
+
+console.log('fooooo')
diff --git a/example/index.js b/example/index.js
@@ -0,0 +1,3 @@
+import template from 'https://unpkg.com/lodash/template'
+
+console.log(template(`Hello <%= name %>`)({name: 'EGOIST'}))
diff --git a/example/webpack.config.js b/example/webpack.config.js
@@ -0,0 +1,26 @@
+const ImportHttpPlugin = require('..')
+
+module.exports = {
+  mode: 'development',
+  devtool: false,
+  entry: __dirname + '/index.js',
+  output: {
+    path: __dirname + '/dist',
+    filename: 'main.js'
+  },
+  plugins: [
+    new ImportHttpPlugin({
+      reload: process.env.RELOAD
+    })
+  ],
+  stats: {
+    colors: true,
+    chunks: false,
+    children: false,
+    modules: false,
+    hash: false,
+    version: false,
+    timings: false,
+    builtAt: false
+  }
+}
diff --git a/lib/http-cache.js b/lib/http-cache.js
@@ -0,0 +1,25 @@
+const { outputFile } = require('./utils')
+
+module.exports = file => {
+  let data = {}
+
+  try {
+    data = require(file)
+  } catch (error) {}
+
+  return {
+    async set(key, value) {
+      data[key] = value
+      await outputFile(file, JSON.stringify(data), 'utf8')
+    },
+
+    async get(key) {
+      return data[key]
+    },
+
+    async clear() {
+      data = {}
+      await outputFile(file, '{}', 'utf8')
+    }
+  }
+}
diff --git a/lib/index.js b/lib/index.js
@@ -0,0 +1,117 @@
+const os = require('os')
+const path = require('path')
+const { parse: parseURL, resolve: resolveURL } = require('url')
+const fetch = require('node-fetch')
+const builtinModules = require('builtin-modules')
+const { pathExists, outputFile } = require('./utils')
+const createHttpCache = require('./http-cache')
+
+const RESOLVER_ID = 'import-http-resolver'
+
+const HTTP_RE = /^https?:\/\//
+
+class ImportHttpPlugin {
+  constructor(options = {}) {
+    this.reload = options.reload
+    this.cacheDir = options.cacheDir
+      ? path.resolve(options.cacheDir)
+      : path.join(os.homedir(), '.import-http')
+    this.depsDir = path.join(this.cacheDir, 'deps')
+    this.httpCache = createHttpCache(path.join(this.cacheDir, 'requests.json'))
+    // Map<file, moduleId>
+    this.fileModuleCache = new Map()
+  }
+
+  getFilePathFromURL(url) {
+    const { host, pathname, protocol } = parseURL(url)
+    // Where should this url be in the disk
+    return path.join(this.depsDir, protocol.replace(':', ''), host, pathname)
+  }
+
+  apply(compiler) {
+    compiler.resolverFactory.hooks.resolver
+      .for('normal')
+      .tap(RESOLVER_ID, resolver => {
+        const resolvedHook = resolver.ensureHook(`resolve`)
+
+        resolver
+          .getHook(`described-resolve`)
+          .tapAsync(
+            RESOLVER_ID,
+            async (requestContext, resolveContext, callback) => {
+              let id = requestContext.request
+              const { issuer } = requestContext.context
+
+              // if the issuer is a URL (cached in deps dir)
+              // resolve the url
+              if (
+                !HTTP_RE.test(id) &&
+                issuer &&
+                this.fileModuleCache.has(issuer) &&
+                !this.fileModuleCache.has(id)
+              ) {
+                if (/^\./.test(id)) {
+                  // Relative file
+                  // Excluded something like ./node_modules/webpack/buildin/global.js
+                  if (!/node_modules/.test(id)) {
+                    id = resolveURL(this.fileModuleCache.get(issuer), id)
+                  }
+                } else if (!builtinModules.includes(id)) {
+                  // Propably an npm package
+                  id = `https://unpkg.com/${id}`
+                }
+              }
+
+              if (!HTTP_RE.test(id)) {
+                return callback()
+              }
+
+              const canResolve = (request, url) => {
+                this.fileModuleCache.set(request, url)
+                resolver.doResolve(
+                  resolvedHook,
+                  Object.assign({}, requestContext, {
+                    request
+                  }),
+                  null,
+                  resolveContext,
+                  callback
+                )
+              }
+
+              try {
+                // Let's get the actual URL
+                const url = await this.httpCache.get(id)
+                let file
+
+                if (url && !this.reload) {
+                  file = this.getFilePathFromURL(url)
+                  if (await pathExists(file)) {
+                    return canResolve(file, url)
+                  }
+                }
+
+                // We have never requested this before
+                console.log(`Downloading ${id}...`)
+                const res = await fetch(id)
+                if (!res.ok) {
+                  console.error(`Failed to download ${id}...`)
+                  throw new Error(res.statusText)
+                }
+                file = this.getFilePathFromURL(res.url)
+                await this.httpCache.set(id, res.url)
+                const content = await res
+                  .buffer()
+                  .then(buff => buff.toString('utf8'))
+                await outputFile(file, content, 'utf8')
+                canResolve(file, res.url)
+              } catch (error) {
+                callback(error)
+              }
+            }
+          )
+      })
+  }
+}
+
+module.exports = ImportHttpPlugin
diff --git a/lib/utils.js b/lib/utils.js
@@ -0,0 +1,20 @@
+const path = require('path')
+const util = require('util')
+const fs = require('fs')
+
+const mkdir = util.promisify(require('mkdirp'))
+
+const writeFile = util.promisify(fs.writeFile)
+const readFile = util.promisify(fs.readFile)
+
+exports.outputFile = (filepath, data, encoding) =>
+  mkdir(path.dirname(filepath)).then(() => writeFile(filepath, data, encoding))
+
+exports.readFile = readFile
+
+exports.pathExists = fp =>
+  new Promise(resolve => {
+    fs.access(fp, err => {
+      resolve(!err)
+    })
+  })
diff --git a/package.json b/package.json
diff --git a/test/fixture/entry.js b/test/fixture/entry.js
diff --git a/test/index.test.js b/test/index.test.js
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+export default 'foo'`
	`2`	`+`
	`3`	`+console.log('fooooo')`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import template from 'https://unpkg.com/lodash/template'`
	`2`	`+`
	`3`	+console.log(template(`Hello <%= name %>`)({name: 'EGOIST'}))