Giter VIP home page Giter VIP logo

url-mapper's Introduction

Cerebral

A declarative state and side effects management solution for popular JavaScript frameworks

NPM version Build status Coverage Status bitHound Score Commitizen friendly Discord

Maintainer needed

https://gist.github.com/christianalfoni/f1c4bfe320dcb24c403635d9bca3fa40

Documentation

Contribute

The entire Cerebral codebase has been rewritten to encourage contributions. The code is cleaned up, commented and all code is in a "monorepo". That means you can run tests across projects and general management of the code is simplified a lot.

  1. Clone the monorepo: git clone https://github.com/cerebral/cerebral.git
  2. In root: npm install

The packages are located under packages folder and there is no need to run npm install for each package.

Using monorepo for your own apps

If you want to use Cerebral 2 directly from your cloned repo, you can create a symlinks for following directories into the node_modules directory of your app:

  • packages/node_modules/cerebral
  • packages/node_modules/function-tree
  • packages/node_modules/@cerebral

If your app and the cerebral monorepo are in the same folder you can do from inside your app directory:

$ ln -s ../../cerebral/packages/node_modules/cerebral/ node_modules/
# ...

Just remember to unlink the package before installing it from npm:

$ unlink node_modules/cerebral
# ...

Running demos

Go to the respective packages/demos/some-demo-folder and run npm start

Testing

You can run all tests in all packages from root:

npm test

Or you can run tests for specific packages by going to package root and do the same:

npm test

Changing the code

When you make a code change you should create a branch first. When the code is changed and backed up by a test you can commit it from the root using:

npm run commit

This will give you a guide to creating a commit message. Then you just push and create a pull request as normal on Github.

Release process

  • Review and merge PRs into next branch. It is safe to use "Update branch", the commit created by Github will not be part of next history
  • If changes to repo-cooker, clean Travis NPM cache
  • From command line:
$ git checkout next
$ git pull
$ npm install # make sure any new dependencies are installed
$ npm install --no-save repo-cooker # needed to test release, make sure you have latest
$ npm run release # and check release notes
$ git checkout master
$ git pull
$ git merge --ff-only next
$ git push

url-mapper's People

Contributors

bfitch avatar christianalfoni avatar garth avatar guria avatar theoludwig avatar tomconroy avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

url-mapper's Issues

Have route() return the mapped functions result

Wouldn't it make sense to have route() return the route functions result rather the the url - or false if no route was found.

That way you could do something like

mainView(url) {
  return route(url, {
    '/:appId/dash': () => <DashboardContainer props={this.props} />,
    '/:appId/setup': () => <SetupContainer props={this.props} />
  })
}

Or is this approach completely nuts anyway and there is a better way of doing this?

suggested urlMapper api

urlMapper.parse('/bar?bar=baz#hash', '/:foo'); // => { params: { foo: 'bar' }, query: { bar: 'baz' }, hash: 'hash' }
urlMapper.stringify('/:foo', { params: { foo: 'bar' }, query: { bar: 'baz' }, hash: 'hash' }); // => '/bar?bar=baz#hash'
urlMapper.map('/bar?bar=baz#hash', routes, function(match, values){
  match({ route: values })
  return 'some return value';
}); // => 'some return value'
urlMapper.map('/bar?bar=baz#hash', routes); // => { match, values }

I have plans to implement this api for next version of lib. Any suggestions?

params + query doesn't work

given route: /:module.

  • url /some?asd=qwe matches the route but module param would be some?asd=qwe and query is empty
  • url /some/?asd=qwe doesn't match at all

Make It Possible To Pass Options To pathToRegexp object

Currently it doesn't appear to be possible to pass options from Cerebral router to the pathToRegexp object. I'd like to set strict to false so that urls with trailing slashes will match patterns that don't have a trailing slash. If there is another way to accomplish this please let me know.

Uncaught ReferenceError: URLON is not defined

Since reactive router is depreciated I would like to replace with url-mapper.
However as soon as require url-mapper I get this error in the console.
var Mapper = require('url-mapper');

Uncaught ReferenceError: URLON is not defined

Sanity checklist

package.json

  • naming
  • correct urls
  • deps
  • authors
  • contributors
  • license: MIT
  • scripts
  • keywords
  • private: y/n

README

  • badges at top, links at bottom
    • npm
    • build status
    • coverage
    • standard
    • commitizen

tests

  • folder: tests/
  • could be ran on travis
  • testing API, not tied to implementation

other files

  • LICENSE.md MIT
  • CONTRIBUTING.md
  • no generated content
  • .gitignore
  • .npmignore

workflow

  • coverage
  • standard
  • protect master
  • commitizen + cz-customizable
  • ghooks + validate-commit-msg
  • semantic-release
    • version 0.0.0
    • travis
    • cracks

Replace wildcard routes with actual path.

When using a wildcard route at the end of cerebral-router, to catch 404’s, it’s also replacing the url with /* in the urlbar.

It should replace with the actual matched url.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.