From 4c12c653d1e4452146181b0818293b976d389040 Mon Sep 17 00:00:00 2001 From: Jascha Date: Sun, 5 May 2019 01:23:59 +0200 Subject: [PATCH] rename to library-list --- README.md | 38 +++++++++++++++++++------------------- config.js | 2 +- example/app.js | 4 ++-- example/assets/index.js | 2 +- example/pages/index.js | 14 +++++++------- package.json | 12 ++++++------ src/index.js | 22 +++++++++++----------- 7 files changed, 47 insertions(+), 47 deletions(-) diff --git a/README.md b/README.md index cab96a0..119e9ab 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ -## @magic-modules/client-list +## @magic-modules/library-list this is the [@magic-modules](https://github.com/magic-modules/) -ClientList component. +LibraryList component. -shows a list of all [@magic-client](https://github.com/magic-client/) libraries. +shows a list of all [@magic-libraries](https://github.com/magic-libraries/) libraries. -[html docs](https://magic-modules.github.io/client-list/) +[html docs](https://magic-modules.github.io/library-list/) [![NPM version][npm-image]][npm-url] [![Linux Build Status][travis-image]][travis-url] @@ -14,22 +14,22 @@ shows a list of all [@magic-client](https://github.com/magic-client/) libraries. [![Greenkeeper badge][greenkeeper-image]][greenkeeper-url] [![Known Vulnerabilities][snyk-image]][snyk-url] -[npm-image]: https://img.shields.io/npm/v/@magic-modules/client-list.svg -[npm-url]: https://www.npmjs.com/package/@magic-modules/client-list -[travis-image]: https://api.travis-ci.org/magic-modules/client-list.svg?branch=master -[travis-url]: https://travis-ci.org/magic-modules/client-list -[appveyor-image]: https://img.shields.io/appveyor/ci/magicmodules/client-list/master.svg -[appveyor-url]: https://ci.appveyor.com/project/magicmodules/client-list/branch/master -[coveralls-image]: https://coveralls.io/repos/github/magic-modules/client-list/badge.svg -[coveralls-url]: https://coveralls.io/github/magic-modules/client-list -[greenkeeper-image]: https://badges.greenkeeper.io/magic-modules/client-list.svg -[greenkeeper-url]: https://badges.greenkeeper.io/magic-modules/client-list.svg -[snyk-image]: https://snyk.io/test/github/magic-modules/client-list/badge.svg -[snyk-url]: https://snyk.io/test/github/magic-modules/client-list +[npm-image]: https://img.shields.io/npm/v/@magic-modules/library-list.svg +[npm-url]: https://www.npmjs.com/package/@magic-modules/library-list +[travis-image]: https://api.travis-ci.org/magic-modules/library-list.svg?branch=master +[travis-url]: https://travis-ci.org/magic-modules/library-list +[appveyor-image]: https://img.shields.io/appveyor/ci/magicmodules/library-list/master.svg +[appveyor-url]: https://ci.appveyor.com/project/magicmodules/library-list/branch/master +[coveralls-image]: https://coveralls.io/repos/github/magic-modules/library-list/badge.svg +[coveralls-url]: https://coveralls.io/github/magic-modules/library-list +[greenkeeper-image]: https://badges.greenkeeper.io/magic-modules/library-list.svg +[greenkeeper-url]: https://badges.greenkeeper.io/magic-modules/library-list.svg +[snyk-image]: https://snyk.io/test/github/magic-modules/library-list/badge.svg +[snyk-url]: https://snyk.io/test/github/magic-modules/library-list #### install: ```bash -npm install --save-exact @magic-modules/client-list +npm install --save-exact @magic-modules/library-list ``` #### usage: @@ -41,7 +41,7 @@ npm install --save-exact @magic-modules/client-list module.exports = { //... other entries - ClientList = require('@magic-modules/client-list'), + LibraryList = require('@magic-modules/library-list'), } ``` @@ -49,7 +49,7 @@ module.exports = { ```javascript // in any component view const component = { - View: () => div([ClientList]), + View: () => div([LibraryList]), } ``` diff --git a/config.js b/config.js index 3a07aaa..4328c20 100644 --- a/config.js +++ b/config.js @@ -1,6 +1,6 @@ module.exports = { ROOT: 'example', - WEB_ROOT: '/client-list/', + WEB_ROOT: '/library-list/', PUBLIC: 'docs', THEME: 'docs', } diff --git a/example/app.js b/example/app.js index 25cda2e..0e5903a 100644 --- a/example/app.js +++ b/example/app.js @@ -1,8 +1,8 @@ module.exports = { state: { - title: '@magic-modules/client-list', + title: '@magic-modules/library-list', description: 'shows a list of all @magic-modules with gitbadges and urls to the docs', - logotext: 'ClientList', + logotext: 'LibraryList', menu: [ { to: '/#installation', text: 'installation' }, { to: '/#require', text: 'require' }, diff --git a/example/assets/index.js b/example/assets/index.js index 8ca306c..0c21bcc 100644 --- a/example/assets/index.js +++ b/example/assets/index.js @@ -1,5 +1,5 @@ module.exports = { Pre: require('@magic-modules/pre'), GitBadges: require('@magic-modules/git-badges'), - ClientList: require('../../src'), + LibraryList: require('../../src'), } diff --git a/example/pages/index.js b/example/pages/index.js index df681ed..da6e07f 100644 --- a/example/pages/index.js +++ b/example/pages/index.js @@ -3,14 +3,14 @@ module.exports = state => [ p([ 'this is the ', Link({ to: 'https://github.com/magic-modules' }, '@magic-modules'), - ' ClientList component. ', + ' LibraryList component. ', state.description, ]), - GitBadges('magic-modules/client-list'), + GitBadges('magic-modules/library-list'), h2({ id: 'installation' }, 'installation'), - Pre('npm install magic-modules/client-list'), + Pre('npm install magic-modules/library-list'), h2({ id: 'require' }, 'require'), p('first add the component to the assets'), @@ -18,22 +18,22 @@ module.exports = state => [ // assets/index.js module.exports = { //...other exports - ClientList: require('@magic-modules/client-list'), + LibraryList: require('@magic-modules/library-list'), }`), h2({ id: 'usage' }, 'usage'), p('in a page or component'), - Pre('module.exports = () => [ClientList]'), + Pre('module.exports = () => [LibraryList]'), h2({ id: 'demo' }, 'demo'), p('this is what it looks like'), - ClientList, + LibraryList, h2({ id: 'source' }, 'source'), p([ 'the source for this page is in the ', Link( - { to: 'https://github.com/magic-modules/client-list/tree/master/example' }, + { to: 'https://github.com/magic-modules/library-list/tree/master/example' }, 'example directory', ), ' and gets built and published to github using ', diff --git a/package.json b/package.json index 0e0f6d7..1d3bf2f 100644 --- a/package.json +++ b/package.json @@ -1,9 +1,9 @@ { - "name": "@magic-modules/client-list", + "name": "@magic-modules/library-list", "version": "0.0.1", "author": "Wizards & Witches", - "description": "@magic-modules/client-list. displays a list of all @magic-client libraries.", - "homepage": "https://magic-modules.github.io/client-list", + "description": "@magic-modules/library-list. displays a list of all @magic-libraries libraries.", + "homepage": "https://magic-modules.github.io/library-list", "scripts": { "start": "t -p", "format": "f -w --exclude docs", @@ -19,10 +19,10 @@ ], "repository": { "type": "git", - "url": "git+https://github.com/magic-modules/client-list.git" + "url": "git+https://github.com/magic-modules/library-list.git" }, "bugs": { - "url": "https://github.com/magic-modules/client-list/issues" + "url": "https://github.com/magic-modules/library-list/issues" }, "dependencies": { "@magic-modules/git-list": "github:magic-modules/git-list" @@ -36,7 +36,7 @@ }, "keywords": [ "magic", - "client-list" + "library-list" ], "license": "AGPL-3.0", "contributors": [ diff --git a/src/index.js b/src/index.js index ba52eda..a6107f9 100644 --- a/src/index.js +++ b/src/index.js @@ -1,26 +1,26 @@ -const ClientList = props => - CHECK_PROPS(props, ClientList.props, 'ModuleList') && +const LibraryList = props => + CHECK_PROPS(props, LibraryList.props, 'ModuleList') && GitList({ - id: 'magic-client', - org: 'magic-client', - header: [Link({ to: 'https://magic-client.github.io' }, '@magic-client libraries')], + id: 'magic-libraries', + org: 'magic-libraries', + header: [Link({ to: 'https://magic-libraries.github.io' }, '@magic-libraries libraries')], desc: ['below is a collection of the available @magic client libraries.'], items: [ { name: 'json', description: [ - 'the @magic-client/json module parses and stringifies json.', + 'the @magic-libraries/json module parses and stringifies json.', ' it also returns errors instead of throwing them.', ], }, { name: 'is', - description: 'the @magic-client/is module unifies the javascript type testing apis.', + description: 'the @magic-libraries/is module unifies the javascript type testing apis.', }, { name: 'uri', description: [ - 'the @magic-client/uri module ', + 'the @magic-libraries/uri module ', ' encodes objects to uri strings and decodes uri strings to objects.', ], }, @@ -28,11 +28,11 @@ const ClientList = props => ...props, }) -ClientList.dependencies = { +LibraryList.dependencies = { GitList: require('@magic-modules/git-list'), } -ClientList.props = [ +LibraryList.props = [ { key: 'id', type: 'string' }, { key: 'org', type: 'string' }, { key: 'header', type: 'string' }, @@ -40,4 +40,4 @@ ClientList.props = [ { key: 'items', type: 'array' }, ] -module.exports = ClientList +module.exports = LibraryList