feat: added new package for utils

Author: pixelass

components/pagers/package.json

@@ -55,8 +55,10 @@
 	"dependencies": {
 		"@stickyroll/context": "^1.0.0",
 		"@stickyroll/themes": "^1.0.0",
+		"@stickyroll/utils": "^1.0.0",
 		"@types/react": "^16.7.13",
 		"@types/styled-components": "^4.1.3",
+		"ava": "1.0.0-rc.2",
 		"react": "^16.6.3",
 		"styled-components": "^4.1.2",
 		"ts-lib": "0.0.5"

components/pagers/src/pagers.tsx

@@ -1,20 +1,9 @@
 import React from "react";
-import styled, {css, StyledComponent} from "styled-components";
-import {ScrollConsumer} from "@stickyroll/context";
-import {light, ITheme} from "@stickyroll/themes";
-
-/**
- *
- * @param {any} value
- * @param {string} type
- * @throws {?TypeError}
- */
-export const assert = (value: any, type: string): void => {
-	const valueType = typeof value;
-	if (valueType !== type) {
-		throw new TypeError(`Expected "${type}" but "${valueType}" was received`);
-	}
-};
+import styled, { css, StyledComponent } from "styled-components";
+import { ScrollConsumer } from "@stickyroll/context";
+import { ITheme, light } from "@stickyroll/themes";
+import { scrollTo } from "@stickyroll/utils";
+import { assert } from "@stickyroll/utils";
 
 /**
  * @extends React.HTMLAttributes<HTMLAnchorElement>
@@ -221,47 +210,6 @@ export const SkipLink: StyledComponent<"a", {}> = styled.a`
 	}
 `;
 
-/**
- * @typedef {object} IScrollOptions
- * @property {boolean} noFocus
- * @property {boolean} noHash
- */
-export interface IScrollToOptions {
-	noFocus?: boolean;
-	noHash?: boolean;
-}
-
-/**
- * @param {string} hash
- * @param {HTMLElement} target
- * @param {IScrollToOptions} [options={}]
- * @return {void}
- */
-const scrollTo = (hash: string, target: HTMLElement, options: IScrollToOptions = {}): void => {
-	if (!options.noHash) {
-		window.location.hash = hash;
-	}
-	const el = document.getElementById(hash);
-	if (!options.noFocus) {
-		target.focus();
-	}
-
-	// Attempted to implement smooth scrolling if the page changes by one position.
-	// The page jumps in several state changes
-	// @todo Fix unless a browser bug exists.
-	// const index = parseInt(hash.split("/").reverse()[0], 10) - 1;
-	// const diff = Math.abs(index - page);
-	// document.documentElement.style["scroll-behavior"] = diff > 1 ? "auto" : "smooth";
-
-	el.scrollIntoView(true);
-
-	// Optionally if Element.scrollIntoView does not return the expected result.
-	// const {top: tEl} = el.getBoundingClientRect();
-	// const {top: tBody} = document.body.getBoundingClientRect();
-	// const offset = tEl - tBody;
-	// window.scrollTo(0, offset);
-};
-
 /**
  * @typedef {object} ISkipBaseProps
  * @property {string} prefix
@@ -363,11 +311,6 @@ export const PagerBase: React.FunctionComponent<IPagerBaseProps> = props => {
 	);
 };
 
-/**
- * Make all properties in T optional
- */
-type PartialProps<T> = {[P in keyof T]?: T[P]};
-
 /**
  * @extends Partial<IPagerBaseProps>
  * @typedef {object} IPagersProps

packages/utils/.babelrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+	"extends": require.resolve("imhotep/config/.babelrc")
+}

packages/utils/.editorconfig

@@ -0,0 +1,29 @@
+root = true
+
+[*]
+indent_style = tab
+indent_size = 4
+end_of_line = lf
+trim_trailing_spaces = true
+insert_final_newline = true
+
+# trailing spaces in markdown indicate word wrap
+[*.md]
+trim_trailing_spaces = false
+max_line_length = 100
+
+
+# Set default charset
+[*.{ts,tsx,js,jsx}]
+charset = utf-8
+max_line_length = 100
+
+# Set indents
+[*.{yml,json}]
+max_line_length = 100
+indent_size = 2
+
+# Set spaces
+[*.{yml}]
+max_line_length = 100
+indent_style = space

packages/utils/.prettierrc

@@ -0,0 +1 @@
+{}

packages/utils/.stylelintrc

@@ -0,0 +1,4 @@
+{
+	"processors": ["stylelint-processor-styled-components"],
+	"extends": ["imhotep/config/.stylelintrc", "stylelint-config-styled-components"]
+}

packages/utils/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 stickyroll
+
+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.

packages/utils/README.md

@@ -0,0 +1,7 @@
+# Stickyroll utils
+
+Utils for stickyroll.
+
+```bash
+yarn add @stickyroll/utils
+```

packages/utils/ava.config.js

@@ -0,0 +1,8 @@
+export default {
+	compileEnhancements: false,
+	require: [],
+	babel: {
+		extensions: ["js", "jsx"]
+	},
+	files: ["test/**/*.js"]
+};

packages/utils/imhotep.config.js

@@ -0,0 +1,11 @@
+module.exports = {
+	lib: {
+		path: "dist"
+	},
+	types: {
+		path: "dist"
+	},
+	src: {
+		path: "src"
+	}
+};