Move insert-link and settings to separate packages (OctoLinker#435)

* Move link creation to packages * Move insert-link related dependencies * Remove link indicator option to simplify things * Update import statements to load insert-link helper * Move insert-link tests * Move link realted css * Mock css to make jest working For details visit https://facebook.github.io/jest/docs/en/webpack.html * Revert "Remove link indicator option to simplify things" This reverts commit 5db577f. * Revert "Move link realted css" This reverts commit dd8e0f0. * Move insert link css * Move settings into package * fixup! Revert "Move link realted css" * Move settings related dependencies * Update import paths * fixup! Revert "Remove link indicator option to simplify things" * Sort octolinker packages * Fix "wraps once" test setup
apryl489 · Jan 31, 2018 · e490c86 · e490c86
1 parent 841ca9a
commit e490c86
Show file tree

Hide file tree

Showing 27 changed files with 64 additions and 29 deletions.
diff --git a/__mocks__/styleMock.js b/__mocks__/styleMock.js
@@ -0,0 +1 @@
+module.exports = {};
diff --git a/package.json b/package.json
@@ -21,6 +21,9 @@
     "firefox-launch": "web-ext run --source-dir dist --pref startup.homepage_welcome_url=https://github.com/OctoLinker/OctoLinker/blob/master/package.json"
   },
   "jest": {
+    "moduleNameMapper": {
+      "\\.css$": "<rootDir>/__mocks__/styleMock.js"
+    },
     "setupFiles": [
       "./_jestsetup.js"
     ]

diff --git a/packages/core/app.js b/packages/core/app.js
@@ -1,6 +1,5 @@
+import * as storage from '@octolinker/helper-settings';
 import OctoLinker from './octo-linker.js';
-import * as storage from './options/storage.js';
-import './app.css';
 
 storage.load().then(() => {
   const octoLinker = new OctoLinker();

diff --git a/packages/core/background/index.js b/packages/core/background/index.js
@@ -1,4 +1,4 @@
-import * as storage from '../options/storage.js';
+import * as storage from '@octolinker/helper-settings';
 import newTab from './newTab';
 import insight from './insight';
 

diff --git a/packages/core/click-handler.js b/packages/core/click-handler.js
@@ -1,6 +1,6 @@
 import $ from 'jquery';
+import * as storage from '@octolinker/helper-settings';
 import { showTooltip, removeTooltip } from './gh-interface.js';
-import * as storage from './options/storage.js';
 import fetch from './utils/fetch.js';
 
 const SORRY = "I'm sorry, unable to resolve this link  😱";

diff --git a/packages/core/notification.js b/packages/core/notification.js
@@ -1,5 +1,5 @@
+import * as storage from '@octolinker/helper-settings';
 import { showNotification } from './gh-interface';
-import * as storage from './options/storage.js';
 
 const pkgVersion = require('./package.json')
   .version.split('.')

diff --git a/packages/core/octo-linker.js b/packages/core/octo-linker.js
@@ -1,12 +1,12 @@
 import injection from 'github-injection';
 import BlobReader from '@octolinker/blob-reader';
+import insertLink from '@octolinker/helper-insert-link';
+import * as storage from '@octolinker/helper-settings';
 import notification from './notification';
 import clickHandler from './click-handler';
 import Plugins from './plugin-manager.js';
-import insertLink from './insert-link';
 import debugMode from './debug-mode.js';
 import * as loadPlugins from './load-plugins';
-import * as storage from './options/storage.js';
 
 function initialize(self) {
   debugMode(storage.get('debugMode'));

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -6,27 +6,22 @@
   "license": "MIT",
   "main": "./index.js",
   "dependencies": {
+    "@octolinker/blob-reader": "1.0.0",
+    "@octolinker/helper-grammar-regex-collection": "1.0.0",
+    "@octolinker/helper-insert-link": "1.0.0",
+    "@octolinker/helper-settings": "1.0.0",
     "JSONPath": "^0.11.2",
     "builtins": "^1.0.3",
-    "chrome-promise": "^2.1.1",
     "concat-map": "^0.0.1",
     "escape-regex-string": "^1.0.4",
-    "findandreplacedomtext": "^0.4.5",
     "github-injection": "^1.0.1",
     "github-url-from-git": "^1.5.0",
     "github-url-from-username-repo": "^1.0.2",
     "giturl": "^1.0.0",
     "jquery": "^3.2.1",
-    "linkstate": "^1.1.0",
-    "@octolinker/blob-reader": "1.0.0",
-    "@octolinker/helper-grammar-regex-collection": "1.0.0",
     "path-parse": "^1.0.5",
-    "preact": "^8.2.5",
-    "primer-core": "^6.4.0",
-    "primer-forms": "^1.4.0",
     "querystring": "^0.2.0",
     "semver": "^5.4.1",
-    "semver-regex": "^1.0.0",
-    "uuid": "^3.1.0"
+    "semver-regex": "^1.0.0"
   }
 }
diff --git a/packages/core/plugins/bower-manifest.js b/packages/core/plugins/bower-manifest.js
@@ -1,8 +1,8 @@
+import insertLink from '@octolinker/helper-insert-link';
 import processJSON from './helper/process-json';
 import { isSemver } from './helper/version';
 import { javascriptFile } from './javascript';
 import { jsonRegExKeyValue, jsonRegExValue } from './helper/regex-builder';
-import insertLink from '../insert-link';
 import liveResolverQuery from '../resolver/live-resolver-query.js';
 import gitUrl from '../resolver/git-url.js';
 import githubShorthand from '../resolver/github-shorthand.js';

diff --git a/packages/core/plugins/composer-manifest.js b/packages/core/plugins/composer-manifest.js
@@ -1,6 +1,6 @@
+import insertLink from '@octolinker/helper-insert-link';
 import processJSON from './helper/process-json';
 import { jsonRegExKeyValue } from './helper/regex-builder';
-import insertLink from '../insert-link';
 import liveResolverQuery from '../resolver/live-resolver-query.js';
 
 function linkDependency(blob, key, value) {

diff --git a/packages/core/plugins/dot-net-core.js b/packages/core/plugins/dot-net-core.js
@@ -1,6 +1,6 @@
+import insertLink from '@octolinker/helper-insert-link';
 import processJSON from './helper/process-json';
 import { jsonRegExKeyValue } from './helper/regex-builder';
-import insertLink from '../insert-link';
 import nugetResolver from '../resolver/nuget';
 
 function linkDependency(blob, key, value) {

diff --git a/packages/core/plugins/npm-manifest.js b/packages/core/plugins/npm-manifest.js
@@ -1,8 +1,8 @@
+import insertLink from '@octolinker/helper-insert-link';
 import processJSON from './helper/process-json';
 import { isSemver } from './helper/version';
 import { javascriptFile } from './javascript';
 import { jsonRegExKeyValue, jsonRegExValue } from './helper/regex-builder';
-import insertLink from '../insert-link';
 import liveResolverQuery from '../resolver/live-resolver-query.js';
 import gitUrl from '../resolver/git-url.js';
 import githubShorthand from '../resolver/github-shorthand.js';

diff --git a/packages/core/resolver/github-search.js b/packages/core/resolver/github-search.js
@@ -1,5 +1,5 @@
 import { extname } from 'path';
-import * as storage from '../options/storage.js';
+import * as storage from '@octolinker/helper-settings';
 
 export default function({ path, target }) {
   const [, user, repo] = path.split('/');

diff --git a/packages/helper-grammar-regex-collection/package.json b/packages/helper-grammar-regex-collection/package.json
@@ -6,8 +6,8 @@
   "license": "MIT",
   "main": "./index.js",
   "dependencies": {
-    "escape-regex-string": "^1.0.4",
     "@octolinker/helper-parser-byline": "^1.0.0",
+    "escape-regex-string": "^1.0.4",
     "xregexp": "^4.0.0"
   }
 }
diff --git a/...__/__snapshots__/insert-link.test.js.snap → ...ink/__tests__/__snapshots__/index.js.snap b/...__/__snapshots__/insert-link.test.js.snap → ...ink/__tests__/__snapshots__/index.js.snap
@@ -191,6 +191,7 @@ exports[`insert-link wraps single quotes 1`] = `
 exports[`insert-link wraps the element once 1`] = `
 <div>
   
+  
   foo 
   <span>
     <i>
@@ -206,6 +207,7 @@ exports[`insert-link wraps the element once 1`] = `
     <i>
       "
       
+      
     </i>
   </span>
 </div>

diff --git a/packages/core/__tests__/insert-link.test.js → ...ges/helper-insert-link/__tests__/index.js b/packages/core/__tests__/insert-link.test.js → ...ges/helper-insert-link/__tests__/index.js
@@ -1,5 +1,5 @@
 import { REQUIRE } from '@octolinker/helper-grammar-regex-collection';
-import insertLink from '../insert-link.js';
+import insertLink from '../index.js';
 
 describe('insert-link', () => {
   const DEFAULT_REGEX = /foo ("\w+")/;
@@ -77,8 +77,10 @@ describe('insert-link', () => {
 
   it('wraps the element once', () => {
     const input = 'foo <span><i>"</i>foo<i>"</i></span>';
+    const el = helper(input);
+    insertLink(el, DEFAULT_REGEX, {}, '$1');
 
-    expect(helper(input)).toMatchSnapshot();
+    expect(el).toMatchSnapshot();
   });
 
   it('adds the given data-* attributes', () => {

diff --git a/packages/core/insert-link.js → packages/helper-insert-link/index.js b/packages/core/insert-link.js → packages/helper-insert-link/index.js
@@ -1,6 +1,7 @@
 import $ from 'jquery';
 import findAndReplaceDOMText from 'findandreplacedomtext';
-import * as storage from './options/storage.js';
+import * as storage from '@octolinker/helper-settings';
+import './style.css';
 
 const CLASS_NAME = 'octolinker-link';
 const CLASS_INDICATOR = 'octolinker-line-indicator';

diff --git a/packages/helper-insert-link/package.json b/packages/helper-insert-link/package.json
@@ -0,0 +1,16 @@
+{
+  "name": "@octolinker/helper-insert-link",
+  "version": "1.0.0",
+  "description": "",
+  "repository": "https://github.com/octolinker/octolinker/tree/master/packages/helper-insert-link",
+  "license": "MIT",
+  "main": "./index.js",
+  "dependencies": {
+    "@octolinker/helper-settings": "1.0.0",
+    "findandreplacedomtext": "^0.4.5",
+    "jquery": "^3.2.1"
+  },
+  "devDependencies": {
+    "@octolinker/helper-grammar-regex-collection": "1.0.0"
+  }
+}
diff --git a/packages/core/app.css → packages/helper-insert-link/style.css b/packages/core/app.css → packages/helper-insert-link/style.css
diff --git a/packages/core/options/components/checkbox.js → ...es/helper-settings/components/checkbox.js b/packages/core/options/components/checkbox.js → ...es/helper-settings/components/checkbox.js
diff --git a/packages/core/options/components/index.js → packages/helper-settings/components/index.js b/packages/core/options/components/index.js → packages/helper-settings/components/index.js
diff --git a/packages/core/options/components/input.js → packages/helper-settings/components/input.js b/packages/core/options/components/input.js → packages/helper-settings/components/input.js
diff --git a/packages/core/options/storage.js → packages/helper-settings/index.js b/packages/core/options/storage.js → packages/helper-settings/index.js
diff --git a/packages/helper-settings/package.json b/packages/helper-settings/package.json
@@ -0,0 +1,16 @@
+{
+  "name": "@octolinker/helper-settings",
+  "version": "1.0.0",
+  "description": "",
+  "repository": "https://github.com/octolinker/octolinker/tree/master/packages/helper-settings",
+  "license": "MIT",
+  "main": "./index.js",
+  "dependencies": {
+    "chrome-promise": "^2.1.1",
+    "linkstate": "^1.1.0",
+    "preact": "^8.2.5",
+    "primer-core": "^6.4.0",
+    "primer-forms": "^1.4.0",
+    "uuid": "^3.1.0"
+  }
+}
diff --git a/packages/core/options/page.js → packages/helper-settings/page.js b/packages/core/options/page.js → packages/helper-settings/page.js
@@ -1,9 +1,9 @@
 import { h, render, Component } from 'preact';
 import linkState from 'linkstate';
 
-import './options.css';
+import './style.css';
 import { Input, Checkbox } from './components';
-import * as storage from './storage';
+import * as storage from './index';
 
 const githubTokenDescription = () => (
   <span>

diff --git a/packages/core/options/options.css → packages/helper-settings/style.css b/packages/core/options/options.css → packages/helper-settings/style.css
diff --git a/webpack.config.js b/webpack.config.js
@@ -5,7 +5,7 @@ module.exports = {
   entry: {
     app: './packages/core/app',
     background: './packages/core/background/index',
-    options: './packages/core/options/page',
+    options: './packages/helper-settings/page',
   },
   devtool: 'source-map',
   output: {
-Original file line number
+Diff line change
@@ Expand Up / @@ -191,6 +191,7 @@ exports[`insert-link wraps single quotes 1`] = ` @@
     exports[`insert-link wraps the element once 1`] = `
     <div>
       foo
       <span>
         <i>
@@ Expand All / @@ -206,6 +207,7 @@ exports[`insert-link wraps the element once 1`] = ` @@
         <i>
           "
         </i>
       </span>
     </div>
@@ Expand Down @@