chore: cleanup 'dist' directory (#1012)

billiegoose · web-flow · commit a1ae219fe915 · 2020-01-27T23:29:21.000-05:00
BREAKING CHANGE: The `internal-apis` are no longer included in the npm package. I never really intended that; they were just for running unit tests. Also, I renamed `dist/for-future/isomorphic-git/index.js` to `dist/index.js` and `dist/for-node/isomorphic-git/index.js` to `dist/index.cjs`.

And I removed the `jasmine` fallback. I'm sorry `jest` uses native modules, but it's just _too good_ not to use and maintaining a fallback test runner is an added complication.
diff --git a/README.md b/README.md
@@ -125,11 +125,11 @@ You can install it from npm.
 npm install --save isomorphic-git
 ```
 
-In the package.json you'll see there are actually 4 different versions:
+In the package.json you'll see there are actually 3 different versions:
 
 ```json
-  "main": "dist/for-node/isomorphic-git/index.js",
-  "module": "dist/for-future/isomorphic-git/index.js",
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
   "unpkg": "dist/bundle.umd.min.js",
 ```
 
@@ -234,7 +234,7 @@ The main difference is the ridiculous amount of hacks involved in the tests.
 We use Facebook's [Jest](https://jestjs.io) for testing, which make doing TDD fast and fun,
 but we also used custom hacks so that the same
 tests will also run in the browser using [Jasmine](https://jasmine.github.io/) via [Karma](https://karma-runner.github.io).
-We even have our own [karma plugin](https://github.com/isomorphic-git/karma-git-http-server-middleware) for serving
+We even have our own [mock server](https://github.com/isomorphic-git/git-http-mock-server) for serving
 git repository test fixtures!
 
 You'll need [Node.js](https://nodejs.org) installed, but everything else is a devDependency.
diff --git a/__tests__/__helpers__/generate-docs.js b/__tests__/__helpers__/generate-docs.js
@@ -2,7 +2,7 @@ const jsdoc = require('jsdoc-api')
 const fs = require('fs')
 const path = require('path')
 const table = require('markdown-table')
-const git = require('../../dist/for-node/isomorphic-git/index.js')
+const git = require('../..')
 
 git.plugins.set('fs', fs)
 
diff --git a/karma.conf.js b/karma.conf.js
@@ -141,12 +141,6 @@ module.exports = function (config) {
     junitReporter: {
       outputDir: './junit'
     },
-    browserify: {
-      transform: [
-        // Replace process.env.CI
-        'envify'
-      ]
-    },
     webpack: {
       mode: 'development',
       devtool: 'inline-source-map',
diff --git a/package-lock.json b/package-lock.json
diff --git a/package-scripts.js b/package-scripts.js
@@ -20,8 +20,6 @@ const optional = cmd =>
 const timeout = n => cmd => `timeout -t ${n}m -- ${cmd}`
 const timeout5 = timeout(5)
 
-const or = (a, b) => `(${a}) || (${b})`
-
 const srcPaths = '*.js src/*.js src/**/*.js __tests__/*.js __tests__/**/*.js'
 
 module.exports = {
@@ -92,18 +90,14 @@ module.exports = {
       stop: `cross-env GIT_HTTP_MOCK_SERVER_PORT=8888 GIT_HTTP_MOCK_SERVER_ROOT=__tests__/__fixtures__ git-http-mock-server stop`
     },
     test: {
-      // We run jest in Travis so we get accurate code coverage that's mapped to the original source.
-      // But by default, we skip 'jest' because I decided to make it an optionalDependency after it was
-      // pointed out to me that it depends on native modules that don't have prebuilt binaries available,
-      // and no one should be required to install Python and a C++ compiler to contribute to this code.
       default: process.env.CI
         ? series.nps(
           'lint.js',
           'build',
           'lint.typescript',
           'build.docs',
           'test.setup',
-          'test.one',
+          'test.jest',
           'test.karma',
           'test.teardown'
         )
@@ -112,18 +106,14 @@ module.exports = {
           'build',
           'lint.typescript',
           'test.setup',
-          'test.one',
+          'test.jest',
           'test.karma',
           'test.teardown'
         ),
       setup: series.nps('proxy.start', 'gitserver.start'),
       teardown: series.nps('proxy.stop', 'gitserver.stop'),
-      one: retry3(or('nps test.jest', 'nps test.jasmine')),
-      jasmine: process.env.CI
-        ? `cross-env NODE_PATH=./dist/for-node ${timeout5('jasmine')}`
-        : `cross-env NODE_PATH=./dist/for-node jasmine`,
       jest: process.env.CI
-        ? `${timeout5('jest --ci --coverage')}`
+        ? retry3(`${timeout5('jest --ci --coverage')}`)
         : `jest --ci --coverage`,
       karma: process.env.CI
         ? retry3('karma start --single-run')
diff --git a/package.json b/package.json
@@ -3,13 +3,13 @@
   "version": "0.0.0-development",
   "description": "A pure JavaScript reimplementation of git for node and browsers",
   "typings": "./src/index.d.ts",
-  "main": "dist/for-node/isomorphic-git/index.js",
+  "main": "dist/index.cjs",
   "browser": {
     "isomorphic-git": "./dist/bundle.umd.min.js",
     "isomorphic-git/internal-apis": "./dist/internal.umd.min.js",
     "./src/utils/http.js": "./src/utils/http-browser.js"
   },
-  "module": "dist/for-future/isomorphic-git/index.js",
+  "module": "dist/index.js",
   "unpkg": "dist/bundle.umd.min.js",
   "bin": {
     "isogit": "./cli.js"
@@ -43,7 +43,12 @@
   },
   "homepage": "https://isomorphic-git.org/",
   "files": [
-    "dist",
+    "dist/index.js",
+    "dist/index.cjs",
+    "dist/browser-tests.json",
+    "dist/bundle.umd.min.js",
+    "dist/bundle.umd.min.js.map",
+    "dist/size_report.html",
     "cli.js",
     "src/errors.d.ts",
     "src/index.d.ts"
@@ -87,7 +92,6 @@
     "git-http-mock-server": "1.2.0",
     "github-comment": "1.0.1",
     "inquirer": "^7.0.0",
-    "jasmine": "3.5.0",
     "jasmine-core": "3.4.0",
     "jest": "24.9.0",
     "jest-fixtures": "wmhilton-contrib/jest-fixtures#win32",
diff --git a/rollup.config.js b/rollup.config.js
@@ -1,3 +1,4 @@
+import path from 'path'
 import resolve from 'rollup-plugin-node-resolve'
 
 import pkg from './package.json'
@@ -7,9 +8,7 @@ const external = [
   'path',
   'crypto',
   'stream',
-  'openpgp/dist/openpgp.min.js',
   'crc/lib/crc32.js',
-  'stream-source/index.node.js',
   'sha.js/sha1',
   ...Object.keys(pkg.dependencies)
 ]
@@ -22,7 +21,7 @@ const moduleConfig = input => ({
     {
       format: 'es',
       name: 'git',
-      file: `dist/for-future/isomorphic-git/${input}`
+      file: `dist/${input}`
     }
   ],
   plugins: [resolve({ browser: true })]
@@ -36,7 +35,7 @@ const nodeConfig = input => ({
     {
       format: 'cjs',
       name: 'git',
-      file: `dist/for-node/isomorphic-git/${input}`
+      file: `dist/${path.basename(input, '.js')}.cjs`
     }
   ]
 })

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+import path from 'path'`
`1`	`2`	`import resolve from 'rollup-plugin-node-resolve'`
`2`	`3`
`3`	`4`	`import pkg from './package.json'`
`@@ -7,9 +8,7 @@ const external = [`
`7`	`8`	`'path',`
`8`	`9`	`'crypto',`
`9`	`10`	`'stream',`
`10`		`- 'openpgp/dist/openpgp.min.js',`
`11`	`11`	`'crc/lib/crc32.js',`
`12`		`- 'stream-source/index.node.js',`
`13`	`12`	`'sha.js/sha1',`
`14`	`13`	`...Object.keys(pkg.dependencies)`
`15`	`14`	`]`
`@@ -22,7 +21,7 @@ const moduleConfig = input => ({`
`22`	`21`	`{`
`23`	`22`	`format: 'es',`
`24`	`23`	`name: 'git',`
`25`		- file: `dist/for-future/isomorphic-git/${input}`
	`24`	+ file: `dist/${input}`
`26`	`25`	`}`
`27`	`26`	`],`
`28`	`27`	`plugins: [resolve({ browser: true })]`
`@@ -36,7 +35,7 @@ const nodeConfig = input => ({`
`36`	`35`	`{`
`37`	`36`	`format: 'cjs',`
`38`	`37`	`name: 'git',`
`39`		- file: `dist/for-node/isomorphic-git/${input}`
	`38`	+ file: `dist/${path.basename(input, '.js')}.cjs`
`40`	`39`	`}`
`41`	`40`	`]`
`42`	`41`	`})`