seeq

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width"> <title>seeq Index</title>  <link type="text/css" rel="stylesheet" href="styles/sunlight.default.css"> <link type="text/css" rel="stylesheet" href="styles/site.spacelab.css"> </head> <body> <div class="navbar navbar-default navbar-fixed-top "> <div class="container"> <div class="navbar-header"> <a class="navbar-brand" href="index.html">seeq</a> <button class="navbar-toggle" type="button" data-toggle="collapse" data-target="#topNavigation"> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button> </div> <div class="navbar-collapse collapse" id="topNavigation"> <ul class="nav navbar-nav"> <li class="dropdown"> <a href="modules.list.html" class="dropdown-toggle" data-toggle="dropdown">Modules<b class="caret"></b></a> <ul class="dropdown-menu "> <li><a href="module-bower.html">bower</a></li><li><a href="module-cdnjs.html">cdnjs</a></li><li><a href="module-cli.html">cli</a></li><li><a href="module-format.html">format</a></li><li><a href="module-format_util.html">format/util</a></li><li><a href="module-github.html">github</a></li><li><a href="module-grunt.html">grunt</a></li><li><a href="module-gulp.html">gulp</a></li><li><a href="module-json.html">json</a></li><li><a href="module-jster.html">jster</a></li><li><a href="module-markdown.html">markdown</a></li><li><a href="module-microjs.html">microjs</a></li><li><a href="module-npm.html">npm</a></li><li><a href="module-raw.html">raw</a></li><li><a href="module-resource.html">resource</a></li><li><a href="module-resource_util.html">resource/util</a></li><li><a href="module-seeq.html">seeq</a></li><li><a href="module-text.html">text</a></li><li><a href="module-webcomponents.html">webcomponents</a></li> </ul> </li> <li class="dropdown"> <a href="classes.list.html" class="dropdown-toggle" data-toggle="dropdown">Classes<b class="caret"></b></a> <ul class="dropdown-menu "> <li><a href="module-resource_util-FailedHttpRequestError.html">resource/util~FailedHttpRequestError</a></li><li><a href="module-resource_util-IncorrectResponseError.html">resource/util~IncorrectResponseError</a></li> </ul> </li> </ul> <div class="col-sm-3 col-md-3"> <form class="navbar-form" role="search"> <div class="input-group"> <input type="text" class="form-control" placeholder="Search" name="q" id="search-input"> <div class="input-group-btn"> <button class="btn btn-default" id="search-submit"><i class="glyphicon glyphicon-search"></i></button> </div> </div> </form> </div> </div> </div> </div> <div class="container" id="toc-content"> <div class="row"> <div class="col-md-8"> <div id="main"> <section class="readme-section"> <article><h1>seeq</h1> <p>Detect whether a name is registered or present on some resource (<a href="https://github.com">GitHub</a>, <a href="https://npmjs.org">NPM</a>, <a href="https://bower.io">Bower</a>, ...).</p> <p>Also allows searching for string on specified resources.</p> <p><a href="http://badge.fury.io/js/seeq"><img src="https://badge.fury.io/js/seeq.png" alt="NPM version"></a> <a href="https://travis-ci.org/gamtiq/seeq"><img src="https://travis-ci.org/gamtiq/seeq.png" alt="Build Status"></a> <a href="http://gruntjs.com/"><img src="https://cdn.gruntjs.com/builtwith.png" alt="Built with Grunt"></a></p> <h2>Available resources</h2> <p>The following resources are available:</p> <ul> <li><a href="https://github.com">GitHub</a></li> <li><a href="https://npmjs.org">NPM</a></li> <li><a href="https://bower.io">Bower</a></li> <li><a href="https://gruntjs.com/plugins">Registry of Grunt plugins</a></li> <li><a href="https://gulpjs.com/plugins">Registry of Gulp plugins</a></li> <li><a href="http://jster.net">JSter</a></li> <li><a href="http://microjs.com">MicroJS</a></li> <li><a href="https://cdnjs.com">CDNJS</a></li> <li><a href="https://www.webcomponents.org">Web components</a></li> </ul> <p>You can see information about all available resources by running <code>seeq -l</code> (see below).</p> <h2>Installation</h2> <p>To install and use seeq <a href="http://nodejs.org">Node.js</a> should be installed in your system. Run the following command to install seeq:</p> <pre><code>npm install -g seeq </code></pre> <h2>Usage</h2> <p>Run <code>seeq</code> to show usage information.</p> <pre class="prettyprint source"><code>> seeq Usage: seeq [name]... [options] name Name/string that should be searched for or checked for presence on a resource Options: -h, --help Show usage information and exit -l, --list-resource Show information about all available resources -r, --at Filter for available resources by name: comma-separated list of names (case-insensitive) of resources that should be checked/searched -t, --tag Filter for available resources by tag: comma-separated list of tags (case-insensitive); -tag means that resource should not have the tag --all-tag Whether all specified tags should be checked for a resource -p, --partial-match Allow partial matching when checking name: 0 - disallow (by default), 1 - allow at the beginning of matching strings, 2 - allow substring matching -c, --case-sensitive Use case-sensitive check/search when possible -s, --search Make search instead of check -m, --limit Limit of quantity of results per resource --timeout Number of seconds to wait for a response before aborting a data request to a resource [60] -f, --format Result format; can be: text, json, markdown, raw [text] -V, --verbose Enable verbose output -v, --version Show program version --github-lang Search GitHub repositories that are written in the specified language --github-limit Limit of quantity of GitHub results; default and maximum value is 100 --github-user GitHub username that should be used for authentication --github-password GitHub account password --github-token GitHub OAuth2 token that should be used for authentication instead of username and password Available resources (9): * GitHub (https://github.com) - GitHub repositories (tags: github repository project library framework package) * NPM (https://npmjs.org) - Node packaged modules registry (tags: npm js javascript package library node) * Bower (https://bower.io) - Bower package manager registry (tags: bower js javascript package component library browser) * Grunt (https://gruntjs.com/plugins) - Registry of Grunt plugins (tags: grunt js javascript plugin registry node task runner) * Gulp (https://gulpjs.com/plugins) - Registry of Gulp plugins (tags: gulp js javascript plugin registry node build) * JSter (http://jster.net) - Catalog of JavaScript libraries and tools for web development (tags: jster js javascript catalog library framework tool) * MicroJS (http://microjs.com) - List of micro-frameworks and micro-libraries (tags: microjs js javascript library framework micro) * CDNJS (https://cdnjs.com) - CDN for popular web development frameworks, libraries, CSS and other assets (tags: cdnjs cdn js javascript library framework css browser) * Web components (https://www.webcomponents.org) - Share and discover reusable web UI components (tags: webcomponents customelements web component webcomponent custom element js javascript css html gallery browser) </code></pre> <p>To make a search you can use <code>sees</code> command (<code>sees</code> equals to <code>seeq -s</code>).</p> <h3>Formats</h3> <p>It is possible to specify format of search result:</p> <ul> <li><code>text</code> - result will be converted into plain text; default format</li> <li><code>json</code> - result will be converted into JSON</li> <li><code>markdown</code> - result will be converted into <a href="http://daringfireball.net/projects/markdown/">Markdown</a></li> <li><code>raw</code> - result will be returned "as is" (raw JSON): in usual mode auxiliary data about resources will be deleted, in verbose mode no processing will be applied</li> </ul> <h3>Examples</h3> <p>Check <code>numgen</code>, <code>three</code> and <code>some-strange-name</code> at resources having <code>package</code> tag and limit results per resource up to 5.</p> <pre class="prettyprint source"><code>> seeq numgen three some-strange-name --tag package --limit 5 Checking GitHub, NPM, Bower... Progress: 9/9 (100%) Results: 1. numgen GitHub - 5 numgen - Creates objects that generate number sequences url: https://github.com/gamtiq/numgen numgen - A little Go command line application to generate ranges of numbers url: https://github.com/maurogestoso/numgen numgen url: https://github.com/namumba22/numgen numgen url: https://github.com/gbochev/numgen numgen - numger prediction url: https://github.com/sndemo/numgen NPM - 1 numgen - Creates objects that generate number sequences url: https://github.com/gamtiq/numgen keywords: number sequence generator Bower - 1 numgen - Creates objects that generate number sequences url: https://github.com/gamtiq/numgen keywords: number sequence generator 2. three GitHub - 3 three - Totally not inspired Rust 3D library url: https://github.com/three-rs/three three - An easy-to-use Python wrapper for the Open311 API. url: three.codeforamerica.org three - A GPL (v2) and Creative Commons (for the assets) game for the ioquake3 engine. url: http://www.ioquake3.org/ NPM - 1 three - JavaScript 3D library url: https://threejs.org/ keywords: three three.js 3d canvas svg webgl Bower - 1 three url: https://github.com/mrdoob/three.js 3. some-strange-name GitHub some-strange-name is not found. NPM some-strange-name is not found. Bower some-strange-name is not found. </code></pre> <p>Check <code>mixing</code> and <code>flight</code> at GitHub and Bower, allow partial matching at the beginning, use case-sensitive search, limit Bower results up to 3 and GitHub results up to 5, include only GitHub projects that are written in JavaScript, show additional information about found items.</p> <pre class="prettyprint source"><code>> seeq mixing flight -r github,bower --partial-match 1 -c --bower-limit 3 --github-limit 5 --github-lang js --verbose Checking GitHub, Bower... Progress: 4/4 (100%) Results: 1. mixing GitHub - 5 mixing - Functions to mix, filter, change and copy/clone objects url: https://github.com/gamtiq/mixing repository: https://github.com/gamtiq/mixing.git language: JavaScript stars: 14 mixing-console-example - Audio mixing console UI example url: https://github.com/wisdman/mixing-console-example repository: https://github.com/wisdman/mixing-console-example.git language: JavaScript license: MIT stars: 3 mixingloom-profiler-example - an example of profiling by mixingloom-profiler url: https://github.com/wighawag/mixingloom-profiler-example repository: https://github.com/wighawag/mixingloom-profiler-example.git language: JavaScript stars: 2 mixing - Spotify API for adding songs and playlists url: https://github.com/forevernitch/mixing repository: https://github.com/forevernitch/mixing.git language: JavaScript mixingMachine - program for new machines url: https://github.com/heidgera/mixingMachine repository: https://github.com/heidgera/mixingMachine.git language: JavaScript Bower - 1 mixing - Functions to mix, filter, change and copy/clone objects url: https://github.com/gamtiq/mixing keywords: mix merge mixin assign object filter map change copy clone modify update version: 1.2.5 repository: https://github.com/gamtiq/mixing.git license: MIT 2. flight GitHub - 5 flight - A component-based, event-driven JavaScript framework from Twitter url: http://flightjs.github.io/ repository: https://github.com/flightjs/flight.git language: JavaScript license: MIT stars: 6639 flightplan - Run sequences of shell commands against local and remote hosts. url: https://www.npmjs.com/package/flightplan repository: https://github.com/pstadler/flightplan.git language: JavaScript license: MIT stars: 1782 flightDelay - FlightDelay Project url: https://github.com/etherisc/flightDelay repository: https://github.com/etherisc/flightDelay.git language: JavaScript license: MIT stars: 115 flightSimPanels - Flight Simulator Instrument Panels on your Browsers, using UDP over Node.js and Socket.io url: https://github.com/dmolin/flightSimPanels repository: https://github.com/dmolin/flightSimPanels.git language: JavaScript license: GPL-3.0 stars: 85 flightSimulator - Eurofighter Typhoon simulated driving(???????????) url: https://github.com/renjianfeng/flightSimulator repository: https://github.com/renjianfeng/flightSimulator.git language: JavaScript stars: 39 Bower - 3 flight - Clientside component infrastructure url: https://github.com/flightjs/flight version: 1.5.1 repository: https://github.com/flightjs/flight.git flight-yql url: https://github.com/msecret/flight-yql version: 0.2.2 repository: https://github.com/msecret/flight-yql.git flight-withEach url: https://github.com/olivierlesnicki/flight-withEach version: 1.0.0 repository: https://github.com/olivierlesnicki/flight-withEach.git </code></pre> <p>Search for <code>pegasus</code> at resources that have tag <code>library</code> and do not have tags <code>node</code> and <code>cdn</code>, limit results per resource up to 5, print the search result in JSON format.</p> <pre class="prettyprint source"><code>> sees pegasus -m 5 --tag library,-node,-cdn --all-tag -f json Checking GitHub, Bower, JSter, MicroJS... Progress: 4/4 (100%) Results: { "pegasus": { "GitHub": { "result": [ { "name": "pegasus", "description": "A distributed key-value storage system developed and maintained by Xiaomi Cloud Storage Team.", "url": "https://pegasus-kv.github.io/" }, { "name": "pegasus", "description": "Load JSON while still loading other scripts", "url": "http://typicode.github.io/pegasus/" }, { "name": "pegasus", "description": "VM based deployment for prototyping Big Data tools on Amazon Web Services", "url": "https://github.com/InsightDataScience/pegasus" }, { "name": "pegasus", "description": "Pegasus Workflow Management System - Automate, recover, and debug scientific computations.", "url": "https://pegasus.isi.edu/" }, { "name": "Pegasus", "description": "A PEG parser generator for .NET that integrates with MSBuild and Visual Studio.", "url": "http://otac0n.com/Pegasus/" } ] }, "Bower": { "result": [ { "name": "pegasus", "description": "Load data while still loading other scripts, works with jQuery, Backbone, Angular...", "url": "https://github.com/typicode/pegasus", "keywords": [ "ajax", "promise", "xhr", "http", "request", "XMLHttpRequest", "data", "json", "bootstrap", "performance", "optimization", "load", "loader", "preload", "preloader" ] } ] }, "JSter": { "result": [] }, "MicroJS": { "result": [ { "name": "Pegasus", "description": "Load JSON data while still loading other scripts (xhr + promise).", "url": "https://github.com/typicode/pegasus", "keywords": [ "AJAX", "JSON", "GET", "xhr", "request", "promise", "parallel", "performance", "load", "preload" ] } ] } } } </code></pre> <h2>API</h2> <p>In your program you can use API provided by seeq in the following way:</p> <pre class="prettyprint source lang-javascript"><code>var seeq = require("seeq"); ... function onProgress(data) { console.log([data.number, "/", data.total, ": checked ", data.name, " at ", data.resource, ", results - ", data.result.result.length].join("")); } seeq.search(["chronoman", "knockout", "joy"], callback, { resource: ["NPM", "Github", "web components"], settings: { _general: { limit: 5, partialMatch: 2, caseSensitive: true }, github: { limit: 10, language: "js" } }, progressCallback: onProgress }); ... seeq.searchName("duratiform", callback, {resource: ["Bower", "MicroJS"]}); ... seeq.searchName("cheerio", callback, { search: true, resourceTag: ["library", "-cdn"] }); ... seeq.search(["adam", "eva"], function(resultMap) { console.log( seeq.format.format(resultMap, "json", {queryList: ["eva", "adam"], verbose: true}) ); }); </code></pre> <p>See JSDoc-generated documentation in <code>doc</code> folder.</p> <h2>Contributing</h2> <p>In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using <a href="https://gruntjs.com/">Grunt</a>.</p> <h2>License</h2> <p>Copyright (c) 2014-2020 Denis Sikuler<br> Licensed under the MIT license.</p></article> </section> </div> </div> <div class="clearfix"></div> <div class="col-md-3"> <div id="toc" class="col-md-3 hidden-xs hidden-sm hidden-md"></div> </div> </div> </div> <div class="modal fade" id="searchResults"> <div class="modal-dialog"> <div class="modal-content"> <div class="modal-header"> <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button> <h4 class="modal-title">Search results</h4> </div> <div class="modal-body"></div> <div class="modal-footer"> <button type="button" class="btn btn-default" data-dismiss="modal">Close</button> </div> </div> </div> </div> <footer> <span class="copyright"> Copyright (c) 2014-2020 Denis Sikuler </span> <span class="jsdoc-message"> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on 2020-03-08T01:34:34+03:00 using the <a href="https://github.com/docstrap/docstrap">DocStrap template</a>. </span> </footer> <script src="scripts/docstrap.lib.js"></script> <script src="scripts/toc.js"></script> <script type="text/javascript" src="scripts/fulltext-search-ui.js"></script> <script> $( function () { $( "[id*='$']" ).each( function () { var $this = $( this ); $this.attr( "id", $this.attr( "id" ).replace( "$", "__" ) ); } ); $( ".tutorial-section pre, .readme-section pre, pre.prettyprint.source" ).each( function () { var $this = $( this ); var example = $this.find( "code" ); exampleText = example.html(); var lang = /{@lang (.*?)}/.exec( exampleText ); if ( lang && lang[1] ) { exampleText = exampleText.replace( lang[0], "" ); example.html( exampleText ); lang = lang[1]; } else { var langClassMatch = example.parent()[0].className.match(/lang\-(\S+)/); lang = langClassMatch ? langClassMatch[1] : "javascript"; } if ( lang ) { $this .addClass( "sunlight-highlight-" + lang ) .addClass( "linenums" ) .html( example.html() ); } } ); Sunlight.highlightAll( { lineNumbers : true, showMenu : true, enableDoclinks : true } ); $.catchAnchorLinks( { navbarOffset: 10 } ); $( "#toc" ).toc( { anchorName : function ( i, heading, prefix ) { return $( heading ).attr( "id" ) || ( prefix + i ); }, selectors : "#toc-content h1,#toc-content h2,#toc-content h3,#toc-content h4", showAndHide : false, smoothScrolling: true } ); $( "#main span[id^='toc']" ).addClass( "toc-shim" ); $( '.dropdown-toggle' ).dropdown(); $( "table" ).each( function () { var $this = $( this ); $this.addClass('table'); } ); } ); </script>   <script type="text/javascript"> $(document).ready(function() { SearcherDisplay.init(); }); </script> </body> </html>