Skip to content

Commit 482a5ac

Browse files
authored
Merge pull request #14 from data-uri/v2
v2
2 parents d374dbb + b921f98 commit 482a5ac

29 files changed

+112
-10352
lines changed

.devcontainer/devcontainer.json

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,14 @@
1616
// Add the IDs of extensions you want installed when the container is created.
1717
"extensions": [
1818
"dbaeumer.vscode-eslint",
19-
"esbenp.prettier-vscode",
20-
"tlent.jest-snapshot-language-support",
21-
"ms-azuretools.vscode-docker"
19+
"esbenp.prettier-vscode"
2220
],
2321

2422
// Use 'forwardPorts' to make a list of ports inside the container available locally.
2523
// "forwardPorts": [],
2624

2725
// Use 'postCreateCommand' to run commands after the container is created.
28-
// "postCreateCommand": "yarn install",
26+
"postCreateCommand": "npm i",
2927

3028
// Comment out connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
3129
"remoteUser": "node"

.github/workflows/main.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ jobs:
1010
runs-on: ubuntu-latest
1111
strategy:
1212
matrix:
13-
node: ['10', '12', '14', '16']
13+
node: ['12', '14', '16']
1414
name: Check package on Node.js ${{ matrix.node }}
1515
steps:
1616
- uses: actions/checkout@v2

.gitignore

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,6 @@ results
1414

1515
/node_modules
1616
/npm-debug.log
17-
/bower_components
18-
/dist/mimer.d.ts
17+
18+
# mime types db
19+
map.js

.jshintrc

Lines changed: 0 additions & 28 deletions
This file was deleted.

.npmignore

Lines changed: 0 additions & 5 deletions
This file was deleted.

MIT-LICENSE.txt

Lines changed: 0 additions & 21 deletions
This file was deleted.

README.md

Lines changed: 32 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,85 +1,65 @@
1-
Mimer [![Build Status](https://secure.travis-ci.org/data-uri/mimer.png?branch=master)](http://travis-ci.org/data-uri/mimer) [![NPM version](https://badge.fury.io/js/mimer.png)](http://badge.fury.io/js/mimer)
2-
=========
1+
# Mimer [![Build Status](https://github.com/data-uri/mimer/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/data-uri/mimer/actions/workflows/main.yml?query=branch%3Amain)
32

4-
A simple [MIME][mime] type getter built on top of [Node.js][nodejs].
5-
6-
MODULE
7-
---------
8-
9-
**Browser version:**: [Minified][browserminified] (amd and CommonJS ready) [Source][browsersource]
10-
11-
**Node.js version:** `npm install mimer` into your project
3+
> Another [MIME](http://en.wikipedia.org/wiki/MIME) type module. Exposes an extension Map reference of [mime-db](https://npm.im/mime-db) but with zero dependencies.
124
5+
## MODULE
136

147
### Getting started
158
```js
16-
// node and browserify
17-
const Mimer = require('mimer');
18-
19-
// amd (Require.js and etc)
20-
require('path/to/mimer', function (Mimer) {});
9+
const mimer = require('mimer');
2110

22-
// browser (through script tag)
23-
window.Mimer
11+
mimer('.pdf'); // -> "application/pdf"
12+
mimer('pdf'); // -> "application/pdf"
13+
mimer('../readme.pdf'); // -> "application/pdf"
14+
mimer('pedefe'); // -> "application/octet-stream"
2415
```
2516

26-
#### Get a MIME type
17+
#### Extension Map
2718
```js
28-
Mimer('file.css'); // => "text/css"
19+
const mimer = require('mimer');
20+
const mimerMap = require('mimer/map');
2921

30-
// or
31-
var mime = new Mimer();
32-
mime.get('file.css'); // => "text/css"
22+
mimerMap.get('pdf'); // -> "application/pdf"
23+
mimerMap.set('graphql', 'application/graphql');
24+
mimer('content.graphql'); // -> "application/graphql"
3325
```
3426

35-
#### Set a MIME type
27+
#### Safe mode
28+
In case you want to avoid changes on original Map for safety.
3629
```js
37-
var mime = new Mimer();
30+
const mimer = require('mimer/safe');
31+
const mimerMap = require('mimer/map');
3832

39-
mime.set('.monster', 'movie/thriller')
40-
.get('zombie.monster');
41-
// => "movie/thriller"
42-
43-
mime.set(['.rctycoon','.simcity'], 'cms/game');
44-
mime.get('/land/park.rctycoon'); // => "cms/game"
45-
mime.get('maps/city.simcity'); // => "cms/game"
33+
mimerMap.set('graphql', 'application/graphql');
34+
mimer('content.graphql'); // -> "application/octet-stream"
4635
```
4736

48-
CLI
49-
---------
37+
## CLI
5038

51-
`npm install -g mimer` (it may require Root privileges)
39+
```sh
40+
npm install -g mimer
41+
mimer readme.pdf
42+
```
43+
or just
5244

53-
### pritting a mime type
54-
```CLI
55-
$ mimer brand.png
45+
```sh
46+
npx mimer readme.pdf
5647
```
5748

58-
DEVELOPING
59-
----------
49+
## DEVELOPING
50+
51+
Just create a new Github Codespace or:
6052

6153
```CLI
6254
$ npm i
6355
$ npm test
6456
```
6557

66-
Build web version with:
67-
68-
```CLI
69-
$ npm run build
70-
```
71-
7258
## Release notes
7359

7460
See more in [Releases section](https://github.com/data-uri/mimer/releases).
7561

7662
## License
7763

7864
MIT License
79-
(c) [Helder Santana](http://heldr.com)
80-
81-
[nodejs]: http://nodejs.org/download
82-
[bower]: http://bower.io
83-
[mime]: http://en.wikipedia.org/wiki/MIME
84-
[browserminified]: https://raw.github.com/heldr/mimer/master/dist/mimer.min.js
85-
[browsersource]: https://raw.github.com/heldr/mimer/master/dist/mimer.js
65+
(c) [Helder Santana](http://heldr.com)

bower.json

Lines changed: 0 additions & 18 deletions
This file was deleted.

cli.js

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1 @@
1-
/*
2-
* mimer
3-
* https://github.com/heldr/mimer
4-
*
5-
* Copyright (c) 2013 Helder Santana
6-
* Licensed under the MIT license.
7-
* https://raw.github.com/heldr/mimer/master/MIT-LICENSE.txt
8-
*/
9-
10-
var args = process.argv,
11-
Mimer = require('./dist/mimer');
12-
13-
console.log( '"' + Mimer( process.argv[2] ) + '"' );
1+
console.log(`"${require('.')(process.argv[2])}"`);

dist/mimer.js

Lines changed: 0 additions & 67 deletions
This file was deleted.

0 commit comments

Comments
 (0)