Skip to content

Commit b076062

Browse files
committed
feat(core): initial code commit
1 parent 3e2fa1b commit b076062

File tree

9 files changed

+569
-1
lines changed

9 files changed

+569
-1
lines changed

.editorconfig

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# EditorConfig: http://EditorConfig.org
2+
3+
# top-most EditorConfig file
4+
root = true
5+
6+
# Unix-style newlines with a newline ending every file
7+
[*]
8+
charset = utf-8
9+
end_of_line = lf
10+
trim_trailing_whitespace = true
11+
insert_final_newline = true
12+
indent_style = space
13+
indent_size = 4
14+
15+
# 2 space indentation
16+
[*.yaml, *.yml]
17+
indent_style = space
18+
indent_size = 2

.github/workflows/tests.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: Tests
2+
on: ['push', 'pull_request']
3+
jobs:
4+
test:
5+
name: Node.js ${{ matrix.node-version }}
6+
runs-on: ubuntu-latest
7+
strategy:
8+
fail-fast: false
9+
matrix:
10+
node-version: [^12, ^14, ^16, ^17]
11+
steps:
12+
- uses: actions/checkout@v2
13+
- uses: actions/setup-node@v2
14+
with:
15+
node-version: ${{ matrix.node-version }}
16+
- run: npm install
17+
- run: npm test

.gitignore

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Global
2+
node_modules/
3+
4+
# OS Generated
5+
.DS_Store*
6+
ehthumbs.db
7+
Icon?
8+
Thumbs.db
9+
*.swp
10+
11+
# phpstorm
12+
.idea/*

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<a name="1.0.0"></a>
2+
# [1.0.0](https://github.com/faker-javascript/profession) (2022-01-09)
3+
* Initial release

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) Sergey Romanenko
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,43 @@
1-
# profession
1+
<h1 align="center">Profession</h1>
2+
<p align="center">
23
Profession package provides functionality to generate a fake profession value.
4+
</p>
5+
6+
<p align="center">
7+
<a href="https://github.com/faker-javascript/profession/releases"><img alt="Version" src="https://img.shields.io/github/release/faker-javascript/profession.svg?label=version&color=green"></a> <a href="https://github.com/faker-javascript/profession"><img src="https://img.shields.io/badge/license-MIT-blue.svg?color=green" alt="License"></a> <img src="https://github.com/faker-javascript/profession/actions/workflows/tests.yml/badge.svg">
8+
9+
## Install
10+
11+
```
12+
$ npm install --save @fakerjs/profession
13+
```
14+
15+
## Usage
16+
17+
```js
18+
import fakeProfession from '@fakerjs/profession';
19+
20+
fakeProfession();
21+
//=> Software Engineer
22+
23+
fakeProfession({rank: true});
24+
//=> Lead Software Engineer
25+
26+
fakeProfession({rank: true, locale: 'en_US'});
27+
//=> Lead Software Engineer
28+
29+
// Allowed ranks: true, false
30+
// Allowed locales: en_US
31+
```
32+
33+
## Tests
34+
35+
Run tests
36+
37+
```
38+
npm run test
39+
```
40+
41+
## License
42+
[The MIT License (MIT)](https://github.com/faker-javascript/profession/blob/master/LICENSE.txt)
43+
Copyright (c) [Sergey Romanenko](https://github.com/Awilum)

0 commit comments

Comments
 (0)