Skip to content

Commit

Permalink
$ js new
Browse files Browse the repository at this point in the history
  • Loading branch information
make-github-pseudonymous-again committed Sep 17, 2020
1 parent c9f79d2 commit fe1c2c0
Show file tree
Hide file tree
Showing 14 changed files with 398 additions and 102 deletions.
6 changes: 6 additions & 0 deletions .codacy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
languages:
JavaScript: true
exclude_paths:
- "doc/**"
- "lib/**"
- "test/**"
6 changes: 6 additions & 0 deletions .codeclimate.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
languages:
JavaScript: true
exclude_paths:
- "doc/**"
- "lib/**"
- "test/**"
47 changes: 47 additions & 0 deletions .esdoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
{
"source": "./src",
"destination": "./gh-pages",
"debug": false,
"index": "./README.md",
"package": "./package.json",
"plugins": [
{
"name": "esdoc-standard-plugin",
"option": {
"accessor": {
"access": ["public", "protected", "private"],
"autoPrivate": true
},
"brand": {
"title": "@aureooms/js-insertion-sort"
},
"test": {
"type": "ava",
"source": "./test/src"
},
"manual": {
"files":[
"./doc/manual/overview.md",
"./doc/manual/installation.md",
"./doc/manual/usage.md",
"./doc/manual/example.md"
]
}
}
},
{
"name": "esdoc-inject-style-plugin",
"option": {
"enable": true,
"styles": ["./doc/css/style.css"]
}
},
{
"name": "esdoc-inject-script-plugin",
"option": {
"enable": true,
"scripts": ["./doc/scripts/header.js"]
}
}
]
}
112 changes: 12 additions & 100 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,104 +1,16 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
# lock file
!yarn.lock

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
# Generated files
/lib

# Runtime data
pids
*.pid
*.seed
*.pid.lock
# Dependency directory
node_modules
jspm_packages

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov
# Coverage directory used by nyc
/coverage
/.nyc_output

# Coverage directory used by tools like istanbul
coverage
*.lcov

# nyc test coverage
.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# TypeScript v1 declaration files
typings/

# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variables file
.env
.env.test

# parcel-bundler cache (https://parceljs.org/)
.cache

# Next.js build output
.next

# Nuxt.js build / generate output
.nuxt
dist

# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and *not* Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public

# vuepress build output
.vuepress/dist

# Serverless directories
.serverless/

# FuseBox cache
.fusebox/

# DynamoDB Local files
.dynamodb/

# TernJS port file
.tern-port
# Documentation
/gh-pages
22 changes: 22 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
language: node_js

node_js:
- node

install:
- npm install

before_script:
- curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
- chmod +x ./cc-test-reporter
- ./cc-test-reporter before-build

script:
- npm run travis

after_script:
- ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

after_success:
- bash <(curl -s https://codecov.io/bash) || true
- coveralls < coverage/lcov.info || true
27 changes: 25 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,25 @@
# js-insertion-sort
Insertion sorting algorithms for JavaScript
[@aureooms/js-insertion-sort](https://aureooms.github.io/js-insertion-sort)
==

Insertion sorting algorithms for JavaScript.
See [docs](https://aureooms.github.io/js-insertion-sort/index.html).

> :warning: The code requires `regeneratorRuntime` to be defined, for instance by importing
> [regenerator-runtime/runtime](https://www.npmjs.com/package/regenerator-runtime).
[![License](https://img.shields.io/github/license/aureooms/js-insertion-sort.svg)](https://raw.githubusercontent.com/aureooms/js-insertion-sort/master/LICENSE)
[![Version](https://img.shields.io/npm/v/@aureooms/js-insertion-sort.svg)](https://www.npmjs.org/package/@aureooms/js-insertion-sort)
[![Build](https://img.shields.io/travis/aureooms/js-insertion-sort/master.svg)](https://travis-ci.org/aureooms/js-insertion-sort/branches)
[![Dependencies](https://img.shields.io/david/aureooms/js-insertion-sort.svg)](https://david-dm.org/aureooms/js-insertion-sort)
[![Dev dependencies](https://img.shields.io/david/dev/aureooms/js-insertion-sort.svg)](https://david-dm.org/aureooms/js-insertion-sort?type=dev)
[![GitHub issues](https://img.shields.io/github/issues/aureooms/js-insertion-sort.svg)](https://github.com/aureooms/js-insertion-sort/issues)
[![Downloads](https://img.shields.io/npm/dm/@aureooms/js-insertion-sort.svg)](https://www.npmjs.org/package/@aureooms/js-insertion-sort)

[![Code issues](https://img.shields.io/codeclimate/issues/aureooms/js-insertion-sort.svg)](https://codeclimate.com/github/aureooms/js-insertion-sort/issues)
[![Code maintainability](https://img.shields.io/codeclimate/maintainability/aureooms/js-insertion-sort.svg)](https://codeclimate.com/github/aureooms/js-insertion-sort/trends/churn)
[![Code coverage (cov)](https://img.shields.io/codecov/c/gh/aureooms/js-insertion-sort/master.svg)](https://codecov.io/gh/aureooms/js-insertion-sort)
<!--[![Code coverage (alls)](https://img.shields.io/coveralls/github/aureooms/js-insertion-sort/master.svg)](https://coveralls.io/r/aureooms/js-insertion-sort)-->
<!--[![Code coverage (clim)](https://img.shields.io/codeclimate/coverage/aureooms/js-insertion-sort.svg)](https://codeclimate.com/github/aureooms/js-insertion-sort/trends/test_coverage_new_code)-->
[![Code technical debt](https://img.shields.io/codeclimate/tech-debt/aureooms/js-insertion-sort.svg)](https://codeclimate.com/github/aureooms/js-insertion-sort/trends/technical_debt)
[![Documentation](https://aureooms.github.io/js-insertion-sort/badge.svg)](https://aureooms.github.io/js-insertion-sort/source.html)
[![Package size](https://img.shields.io/bundlephobia/minzip/@aureooms/js-insertion-sort)](https://bundlephobia.com/result?p=@aureooms/js-insertion-sort)
52 changes: 52 additions & 0 deletions doc/css/style.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
h1,
h2,
.navigation,
.layout-container > header,
footer
{
border: none;
}

.project-name {
color: #FC913A;
font-weight: bold;
}

.layout-container > header > a.repo-url-github {
font-size: inherit;
display: inline;
background: none;
vertical-align: inherit;
}

.search-box img {
display: none;
}

.search-box::before{
content: "search";
}

.search-input-edge {
height: 0px;
}

.search-result {
width: 300px;
margin-left: 42px;
box-shadow: 1px 1px 13px rgba(0,0,0,0.2);
}

.search-input {
visibility: visible;
}

.search-result li.search-separator {
text-transform: capitalize;
background-color: #ccc;
}

span[data-ice="signature"] > span {
/*font-weight: bold;*/
font-style: italic;
}
3 changes: 3 additions & 0 deletions doc/manual/example.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Examples

> More examples in [the test files](https://github.com/aureooms/js-insertion-sort/tree/master/test/src).
22 changes: 22 additions & 0 deletions doc/manual/installation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Installation

Can be managed using
[yarn](https://yarnpkg.com/en/docs),
[npm](https://docs.npmjs.com),
or [jspm](https://jspm.org/docs).


### yarn
```terminal
yarn add @aureooms/js-insertion-sort
```

### npm
```terminal
npm install @aureooms/js-insertion-sort --save
```

### jspm
```terminal
jspm install npm:@aureooms/js-insertion-sort
```
1 change: 1 addition & 0 deletions doc/manual/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Overview
18 changes: 18 additions & 0 deletions doc/manual/usage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Usage

> :warning: The code requires `regeneratorRuntime` to be defined, for instance by importing
> [regenerator-runtime/runtime](https://www.npmjs.com/package/regenerator-runtime).
First, require the polyfill at the entry point of your application
```js
require( 'regenerator-runtime/runtime' );
// or
import 'regenerator-runtime/runtime.js' ;
```

Then, import the library where needed
```js
const insertionsort = require( '@aureooms/js-insertion-sort' ) ;
// or
import * as insertionsort from '@aureooms/js-insertion-sort' ;
```
34 changes: 34 additions & 0 deletions doc/scripts/header.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
var domReady = function(callback) {
var state = document.readyState ;
if ( state === 'interactive' || state === 'complete' ) {
callback() ;
}
else {
document.addEventListener('DOMContentLoaded', callback);
}
} ;


domReady(function(){

var projectname = document.createElement('a');
projectname.classList.add('project-name');
projectname.text = 'aureooms/js-insertion-sort';
projectname.href = './index.html' ;

var header = document.getElementsByTagName('header')[0] ;
header.insertBefore(projectname,header.firstChild);

var testlink = document.querySelector('header > a[data-ice="testLink"]') ;
testlink.href = 'https://coveralls.io/github/aureooms/js-insertion-sort' ;
testlink.target = '_BLANK' ;

var searchBox = document.querySelector('.search-box');
var input = document.querySelector('.search-input');

// active search box when focus on searchBox.
input.addEventListener('focus', function(){
searchBox.classList.add('active');
});

});
Loading

0 comments on commit fe1c2c0

Please sign in to comment.