# [url](https://github.com/jsmini/url)

[![](https://img.shields.io/badge/Powered%20by-jslib%20url-brightgreen.svg)](https://github.com/yanhaijing/jslib-url)
[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/jsmini/url/blob/master/LICENSE)
[![CI](https://github.com/jsmini/url/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/jsmini/url/actions/workflows/ci.yml)
[![npm](https://img.shields.io/badge/npm-0.6.0-orange.svg)](https://www.npmjs.com/package/@jsmini/url)
[![NPM downloads](http://img.shields.io/npm/dm/@jsmini/url.svg?style=flat-square)](http://www.npmtrends.com/@jsmini/url)
[![Percentage of issues still open](http://isitmaintained.com/badge/open/jsmini/url.svg)](http://isitmaintained.com/project/jsmini/url 'Percentage of issues still open')

url解析库

[English](./README.md) | 简体中文

## 兼容性

单元测试保证支持如下环境：

| IE  | CH  | FF  | SF  | OP  | IOS | 安卓 | Node  |
| --- | --- | --- | --- | --- | --- | ---- | ----- |
| 6+  | 23+ | 4+  | 6+  | 10+ | 5+  | 2.3+ | 0.10+ |

## 目录介绍

```
.
├── demo 使用demo
├── dist 编译产出代码
├── doc 项目文档
├── src 源代码目录
├── test 单元测试
├── CHANGELOG.md 变更日志
└── TODO.md 计划功能
```

## 如何使用

通过npm下载安装代码

```bash
$ npm install --save @jsmini/url
```

如果你是node环境

```js
var name = require('@jsmini/url').name;
```

如果你是webpack等环境

```js
import { name } from '@jsmini/url';
```

如果你是requirejs环境

```js
requirejs(
  ['node_modules/@jsmini/url/dist/index.aio.js'],
  function (jsmini_url) {
    var name = jsmini_url.name;
  },
);
```

如果你是浏览器环境

```html
<script src="node_modules/@jsmini/url/dist/index.aio.js"></script>

<script>
  var name = jsmini_url.name;
</script>
```

## 文档

[API](https://github.com/jsmini/url/blob/master/doc/api.md)

## 贡献指南 ![PRs welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)

首次运行需要先安装依赖

```bash
$ npm install
```

一键打包生成生产代码

```bash
$ npm run build
```

运行单元测试，浏览器环境需要手动测试，位于`test/browser`

```bash
$ npm test
```

修改package.json中的版本号，修改README.md中的版本号，修改CHANGELOG.md，然后发布新版

```bash
$ npm run release
```

将新版本发布到npm

```bash
$ npm publish --access=public
```

重命名项目名称，首次初始化项目是需要修改名字，或者后面项目要改名时使用，需要修改`rename.js`中的`fromName`和`toName`，会自动重命名下面文件中的名字

- README.md 中的信息
- package.json 中的信息
- config/rollup.js 中的信息
- test/browser/index.html 中的仓库名称

```bash
$ npm run rename # 重命名命令
```

## 贡献者列表

[contributors](https://github.com/jsmini/url/graphs/contributors)

## 更新日志

[CHANGELOG.md](https://github.com/jsmini/url/blob/master/CHANGELOG.md)

## 计划列表

[TODO.md](https://github.com/jsmini/url/blob/master/TODO.md)

## 谁在使用