Meta: Reorganize utility functions (refined-github#3110)

contributing.md

@@ -20,7 +20,7 @@ The simplest usage of `feature.add` is the following. This will be run instantly
 
 ```js
 import * as pageDetect from 'github-url-detection';
-import features from '../libs/features';
+import features from '.';
 
 function init () {
 	console.log('✨');
@@ -47,7 +47,8 @@ import React from 'dom-chef';
 import select from 'select-dom';
 import delegate from 'delegate-it';
 import * as pageDetect from 'github-url-detection';
-import features from '../libs/features';
+
+import features from '.';
 
 function append(event: delegate.Event<MouseEvent, HTMLButtonElement>): void {
 	event.delegateTarget.after('✨', <div className="rgh-jsx-element">Button clicked!</div>);

source/features/action-used-by-link.tsx

@@ -3,7 +3,7 @@ import select from 'select-dom';
 import SearchIcon from 'octicon/search.svg';
 import * as pageDetect from 'github-url-detection';
 
-import features from '../libs/features';
+import features from '.';
 
 function init(): void {
 	const actionRepo = select('aside .octicon-repo')!

source/features/add-tag-to-commits.tsx

@@ -4,9 +4,9 @@ import select from 'select-dom';
 import TagIcon from 'octicon/tag.svg';
 import * as pageDetect from 'github-url-detection';
 
-import features from '../libs/features';
-import * as api from '../libs/api';
-import {getOwnerAndRepo, getRepoURL, getRepoGQL} from '../libs/utils';
+import features from '.';
+import * as api from '../github-helpers/api';
+import {getOwnerAndRepo, getRepoURL, getRepoGQL} from '../github-helpers';
 
 interface CommitTags {
 	[name: string]: string[];

source/features/align-issue-labels.tsx

@@ -1,5 +1,5 @@
 import './align-issue-labels.css';
-import features from '../libs/features';
+import features from '.';
 
 function init(): void {
 	document.body.classList.add('rgh-align-issue-labels');

source/features/batch-mark-files-as-viewed.tsx

@@ -2,7 +2,7 @@ import select from 'select-dom';
 import delegate from 'delegate-it';
 import * as pageDetect from 'github-url-detection';
 
-import features from '../libs/features';
+import features from '.';
 
 let previousFile: HTMLElement | undefined;
 

source/features/batch-open-issues.tsx

@@ -4,7 +4,7 @@ import delegate from 'delegate-it';
 import elementReady from 'element-ready';
 import * as pageDetect from 'github-url-detection';
 
-import features from '../libs/features';
+import features from '.';
 
 const confirmationRequiredCount = 10;
 

source/features/bugs-tab.tsx

@@ -5,10 +5,10 @@ import elementReady from 'element-ready';
 import * as pageDetect from 'github-url-detection';
 import BugIcon from '@primer/octicons/build/svg/bug.svg';
 
-import * as api from '../libs/api';
-import features from '../libs/features';
-import SearchQuery from '../libs/search-query';
-import {getRepoURL} from '../libs/utils';
+import features from '.';
+import * as api from '../github-helpers/api';
+import SearchQuery from '../github-helpers/search-query';
+import {getRepoURL} from '../github-helpers';
 
 const numberFormatter = new Intl.NumberFormat();
 const countBugs = cache.function(async (): Promise<number> => {

source/features/bypass-checks.tsx

@@ -1,8 +1,8 @@
 import select from 'select-dom';
 import * as pageDetect from 'github-url-detection';
 
-import features from '../libs/features';
-import fetchDom from '../libs/fetch-dom';
+import features from '.';
+import fetchDom from '../helpers/fetch-dom';
 
 async function init(): Promise<void> {
 	// This selector excludes URLs that are already external

source/features/ci-link.tsx

@@ -2,10 +2,10 @@ import './ci-link.css';
 import oneTime from 'onetime';
 import * as pageDetect from 'github-url-detection';
 
-import features from '../libs/features';
-import fetchDom from '../libs/fetch-dom';
-import {getRepoURL} from '../libs/utils';
-import {appendBefore} from '../libs/dom-utils';
+import features from '.';
+import fetchDom from '../helpers/fetch-dom';
+import {getRepoURL} from '../github-helpers';
+import {appendBefore} from '../helpers/dom-utils';
 
 // Look for the CI icon in the latest 2 days of commits #2990
 const getIcon = oneTime(fetchDom.bind(null,

source/features/clean-issue-filters.tsx

@@ -3,9 +3,9 @@ import cache from 'webext-storage-cache';
 import elementReady from 'element-ready';
 import * as pageDetect from 'github-url-detection';
 
-import * as api from '../libs/api';
-import features from '../libs/features';
-import {getOwnerAndRepo, getRepoURL, getRepoGQL} from '../libs/utils';
+import features from '.';
+import * as api from '../github-helpers/api';
+import {getOwnerAndRepo, getRepoURL, getRepoGQL} from '../github-helpers';
 
 const hasAnyProjects = cache.function(async (): Promise<boolean> => {
 	const {repository, organization} = await api.v4(`

source/features/clean-rich-text-editor.tsx

@@ -2,7 +2,7 @@ import './clean-rich-text-editor.css';
 import select from 'select-dom';
 import * as pageDetect from 'github-url-detection';
 
-import features from '../libs/features';
+import features from '.';
 
 function hideButtons(): void {
 	document.body.classList.add('rgh-clean-rich-text-editor');

source/features/clean-sidebar.tsx

@@ -4,9 +4,9 @@ import select from 'select-dom';
 import oneTime from 'onetime';
 import * as pageDetect from 'github-url-detection';
 
-import features from '../libs/features';
-import onReplacedElement from '../libs/on-replaced-element';
-import onElementRemoval from '../libs/on-element-removal';
+import features from '.';
+import onReplacedElement from '../helpers/on-replaced-element';
+import onElementRemoval from '../helpers/on-element-removal';
 
 const canEditSidebar = oneTime((): boolean => select.exists('.sidebar-labels .octicon-gear'));
 

source/features/clear-pr-merge-commit-message.tsx

@@ -1,8 +1,8 @@
 import select from 'select-dom';
 import * as pageDetect from 'github-url-detection';
 
-import features from '../libs/features';
-import onPrMergePanelOpen from '../libs/on-pr-merge-panel-open';
+import features from '.';
+import onPrMergePanelOpen from '../github-events/on-pr-merge-panel-open';
 
 function init(): void {
 	const messageField = select<HTMLTextAreaElement>('#merge_message_field')!;

source/features/clone-branch.tsx

@@ -5,11 +5,11 @@ import gitBranch from 'octicon/git-branch.svg';
 import * as textFieldEdit from 'text-field-edit';
 import * as pageDetect from 'github-url-detection';
 
-import * as api from '../libs/api';
-import features from '../libs/features';
-import LoadingIcon from '../libs/icon-loading';
-import {getRepoURL, getRepoGQL} from '../libs/utils';
-import observeElement from '../libs/simplified-element-observer';
+import features from '.';
+import * as api from '../github-helpers/api';
+import LoadingIcon from '../github-helpers/icon-loading';
+import {getRepoURL, getRepoGQL} from '../github-helpers';
+import observeElement from '../helpers/simplified-element-observer';
 
 const getBranchBaseSha = async (branchName: string): Promise<string> => {
 	const {repository} = await api.v4(`

source/features/close-out-of-view-modals.tsx

@@ -1,7 +1,6 @@
 import delegate from 'delegate-it';
 
-import features from '../libs/features';
-import {logError} from '../libs/utils';
+import features from '.';
 
 const observer = new IntersectionObserver(([{intersectionRatio, target}]) => {
 	if (intersectionRatio === 0) {
@@ -17,7 +16,7 @@ function init(): void {
 		setTimeout(() => {
 			const modalBox = summary.parentElement!.querySelector('details-menu')!;
 			if (modalBox.getBoundingClientRect().width === 0) {
-				logError(__filebasename, 'Modal element was not correctly detected for', summary);
+				features.error(__filebasename, 'Modal element was not correctly detected for', summary);
 				return;
 			}
 

source/features/collapsible-content-button.tsx

@@ -5,7 +5,7 @@ import FoldDownIcon from 'octicon/fold-down.svg';
 import * as textFieldEdit from 'text-field-edit';
 import * as pageDetect from 'github-url-detection';
 
-import features from '../libs/features';
+import features from '.';
 
 // Wraps string in at least 2 \n on each side,
 // as long as the field doesn't already have them.

source/features/comment-fields-keyboard-shortcuts.tsx

@@ -1,7 +1,7 @@
 import select from 'select-dom';
 import delegate from 'delegate-it';
 
-import features from '../libs/features';
+import features from '.';
 
 // eslint-disable-next-line import/prefer-default-export
 export function listenToCommentFields(callback: delegate.EventHandler<KeyboardEvent, HTMLTextAreaElement>): void {

source/features/comments-time-machine-links.tsx

@@ -3,9 +3,9 @@ import select from 'select-dom';
 import ClockIcon from 'octicon/clock.svg';
 import * as pageDetect from 'github-url-detection';
 
-import features from '../libs/features';
-import {getRepoURL} from '../libs/utils';
-import {appendBefore} from '../libs/dom-utils';
+import features from '.';
+import {getRepoURL} from '../github-helpers';
+import {appendBefore} from '../helpers/dom-utils';
 
 function addInlineLinks(comment: HTMLElement, timestamp: string): void {
 	const links = select.all<HTMLAnchorElement>(`

source/features/conflict-marker.tsx

@@ -4,8 +4,8 @@ import select from 'select-dom';
 import AlertIcon from 'octicon/alert.svg';
 import * as pageDetect from 'github-url-detection';
 
-import * as api from '../libs/api';
-import features from '../libs/features';
+import features from '.';
+import * as api from '../github-helpers/api';
 
 interface PRConfig {
 	number: string;

source/features/copy-file.tsx

@@ -4,7 +4,7 @@ import delegate from 'delegate-it';
 import * as pageDetect from 'github-url-detection';
 import copyToClipboard from 'copy-text-to-clipboard';
 
-import features from '../libs/features';
+import features from '.';
 
 function handleClick({delegateTarget: button}: delegate.Event<MouseEvent, HTMLButtonElement>): void {
 	const file = button.closest('.Box, .js-gist-file-update-container')!;

source/features/copy-on-y.tsx

@@ -2,7 +2,7 @@ import select from 'select-dom';
 import * as pageDetect from 'github-url-detection';
 import copyToClipboard from 'copy-text-to-clipboard';
 
-import features from '../libs/features';
+import features from '.';
 
 const handler = ({key, target}: KeyboardEvent): void => {
 	if (key === 'y' && (target as Element).nodeName !== 'INPUT') {

source/features/create-release-shortcut.tsx

@@ -1,7 +1,7 @@
 import select from 'select-dom';
 import * as pageDetect from 'github-url-detection';
 
-import features from '../libs/features';
+import features from '.';
 
 function init(): void {
 	const createReleaseButton = select('a[href$="/releases/new"]:not([data-hotkey])');

source/features/cross-deleted-pr-branches.tsx

@@ -3,8 +3,8 @@ import React from 'dom-chef';
 import select from 'select-dom';
 import * as pageDetect from 'github-url-detection';
 
-import {wrap} from '../libs/dom-utils';
-import features from '../libs/features';
+import {wrap} from '../helpers/dom-utils';
+import features from '.';
 
 function init(): void {
 	const lastBranchAction = select.last('.TimelineItem-body .user-select-contain > span:not(.base-ref)');

source/features/cycle-lists-with-keyboard-shortcuts.tsx

@@ -2,7 +2,7 @@ import select from 'select-dom';
 import delegate from 'delegate-it';
 import * as pageDetect from 'github-url-detection';
 
-import features from '../libs/features';
+import features from '.';
 
 function init(): void {
 	let selectableItems: HTMLElement[] = [];

source/features/deep-reblame.tsx

@@ -6,10 +6,10 @@ import delegate from 'delegate-it';
 import VersionIcon from 'octicon/versions.svg';
 import * as pageDetect from 'github-url-detection';
 
-import * as api from '../libs/api';
-import features from '../libs/features';
-import LoadingIcon from '../libs/icon-loading';
-import {getRepoGQL, looseParseInt, parseRoute} from '../libs/utils';
+import features from '.';
+import * as api from '../github-helpers/api';
+import LoadingIcon from '../github-helpers/icon-loading';
+import {getRepoGQL, looseParseInt, parseRoute} from '../github-helpers';
 
 const getPullRequestBlameCommit = mem(async (commit: string, prNumber: number, currentFilename: string): Promise<string> => {
 	const {repository} = await api.v4(`

source/features/default-branch-button.tsx

@@ -3,10 +3,10 @@ import elementReady from 'element-ready';
 import * as pageDetect from 'github-url-detection';
 import ChevronLeftIcon from 'octicon/chevron-left.svg';
 
-import features from '../libs/features';
-import {groupButtons} from '../libs/group-buttons';
-import getDefaultBranch from '../libs/get-default-branch';
-import {getRepoURL, getCurrentBranch, replaceBranch, parseRoute} from '../libs/utils';
+import features from '.';
+import {groupButtons} from '../github-helpers/group-buttons';
+import getDefaultBranch from '../github-helpers/get-default-branch';
+import {getRepoURL, getCurrentBranch, replaceBranch, parseRoute} from '../github-helpers';
 
 async function init(): Promise<false | void> {
 	const defaultBranch = await getDefaultBranch();

source/features/deprioritize-marketplace-link.tsx

@@ -4,7 +4,7 @@ import domLoaded from 'dom-loaded';
 import elementReady from 'element-ready';
 import * as pageDetect from 'github-url-detection';
 
-import features from '../libs/features';
+import features from '.';
 
 async function init(): Promise<void> {
 	const marketPlaceLink = (await elementReady('.Header-link[href="/marketplace"]'));

source/features/dim-bots.tsx

@@ -2,7 +2,7 @@ import './dim-bots.css';
 import select from 'select-dom';
 import * as pageDetect from 'github-url-detection';
 
-import features from '../libs/features';
+import features from '.';
 
 function init(): void {
 	const bots = select.all([

source/features/discussion-links-on-repo-lists.tsx

@@ -4,8 +4,8 @@ import IssueIcon from 'octicon/issue-opened.svg';
 import * as pageDetect from 'github-url-detection';
 import PullRequestIcon from 'octicon/git-pull-request.svg';
 
-import features from '../libs/features';
-import observeElement from '../libs/simplified-element-observer';
+import features from '.';
+import observeElement from '../helpers/simplified-element-observer';
 
 function init(): void {
 	const repositories = select.all<HTMLAnchorElement>([

source/features/download-folder-button.tsx

@@ -2,7 +2,7 @@ import React from 'dom-chef';
 import select from 'select-dom';
 import * as pageDetect from 'github-url-detection';
 
-import features from '../libs/features';
+import features from '.';
 
 function init(): void {
 	select('.file-navigation .BtnGroup.float-right')?.prepend(

source/features/edit-comments-faster.tsx

@@ -3,7 +3,7 @@ import select from 'select-dom';
 import PencilIcon from 'octicon/pencil.svg';
 import * as pageDetect from 'github-url-detection';
 
-import features from '../libs/features';
+import features from '.';
 
 function init(): void {
 	const menuItems = select.all('details .js-comment-edit-button:not(.rgh-edit-comment)');

source/features/edit-files-faster.tsx

@@ -4,11 +4,11 @@ import select from 'select-dom';
 import PencilIcon from 'octicon/pencil.svg';
 import * as pageDetect from 'github-url-detection';
 
-import {wrap} from '../libs/dom-utils';
-import features from '../libs/features';
-import {parseRoute} from '../libs/utils';
-import getDefaultBranch from '../libs/get-default-branch';
-import onFileListUpdate from '../libs/on-file-list-update';
+import {wrap} from '../helpers/dom-utils';
+import features from '.';
+import {parseRoute} from '../github-helpers';
+import getDefaultBranch from '../github-helpers/get-default-branch';
+import onFileListUpdate from '../github-events/on-file-list-update';
 
 async function init(): Promise<void> {
 	const defaultBranch = await getDefaultBranch();

source/features/edit-readme.tsx

@@ -3,9 +3,9 @@ import select from 'select-dom';
 import PencilIcon from 'octicon/pencil.svg';
 import * as pageDetect from 'github-url-detection';
 
-import features from '../libs/features';
-import {parseRoute} from '../libs/utils';
-import getDefaultBranch from '../libs/get-default-branch';
+import features from '.';
+import {parseRoute} from '../github-helpers';
+import getDefaultBranch from '../github-helpers/get-default-branch';
 
 async function init(): Promise<void | false> {
 	const readmeHeader = select('#readme .Box-header h2');

source/features/embed-gist-inline.tsx

@@ -3,8 +3,8 @@ import domify from 'doma';
 import select from 'select-dom';
 import * as pageDetect from 'github-url-detection';
 
-import features from '../libs/features';
-import {isFirefox} from '../libs/utils';
+import features from '.';
+import {isFirefox} from '../github-helpers';
 
 const isGist = (link: HTMLAnchorElement): boolean =>
 	!link.pathname.includes('.') && // Exclude links to embed files