Skip to content

Commit 34207ba

Browse files
williamniemiecwilliamniemiec
committed
Deploy
0 parents  commit 34207ba

File tree

11 files changed

+784
-0
lines changed

11 files changed

+784
-0
lines changed

‎.github/workflows/macos.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: MacOS
2+
3+
on:
4+
push:
5+
branches: [ master ]
6+
pull_request:
7+
branches: [ master ]
8+
9+
jobs:
10+
build:
11+
runs-on: macos-latest
12+
13+
steps:
14+
- uses: actions/checkout@v2
15+
- name: Set up JDK 11
16+
uses: actions/setup-java@v1
17+
with:
18+
java-version: 11
19+
- name: Build with Maven
20+
run: mvn install

‎.github/workflows/ubuntu.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: Ubuntu
2+
3+
on:
4+
push:
5+
branches: [ master ]
6+
pull_request:
7+
branches: [ master ]
8+
9+
jobs:
10+
build:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- uses: actions/checkout@v2
15+
- name: Set up JDK 11
16+
uses: actions/setup-java@v1
17+
with:
18+
java-version: 11
19+
- name: Build with Maven
20+
run: mvn install

‎.github/workflows/windows.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Windows
2+
3+
on:
4+
push:
5+
branches: [ master ]
6+
pull_request:
7+
branches: [ master ]
8+
9+
jobs:
10+
build:
11+
runs-on: windows-latest
12+
13+
steps:
14+
- uses: actions/checkout@v2
15+
- name: Set up JDK 11
16+
uses: actions/setup-java@v1
17+
with:
18+
java-version: 11
19+
- name: Build with Maven and generate coverage report
20+
env:
21+
GITHUB_USERNAME: williamniemiec
22+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
23+
run: mvn --file pom.xml jacoco:prepare-agent install jacoco:report
24+
- uses: codecov/codecov-action@v1
25+
with:
26+
file: ./**/target/site/jacoco/jacoco.xml
27+
name: codecov

‎.gitignore

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Project
2+
.settings/
3+
4+
# Maven
5+
target/
6+
pom.xml.tag
7+
pom.xml.releaseBackup
8+
pom.xml.versionsBackup
9+
pom.xml.next
10+
release.properties
11+
dependency-reduced-pom.xml
12+
buildNumber.properties
13+
.mvn/timing.properties
14+
.mvn/wrapper/maven-wrapper.jar

‎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) 2021 William Niemiec
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: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
![](https://github.com/wniemiec-io-java/text-file-manager/blob/master/docs/img/logo/logo.jpg)
2+
3+
<h1 align='center'>Text File Manager</h1>
4+
<p align='center'>Read and write text files.</p>
5+
<p align="center">
6+
<a href="https://github.com/wniemiec-io-java/text-file-manager/actions/workflows/windows.yml"><img src="https://github.com/wniemiec-io-java/text-file-manager/actions/workflows/windows.yml/badge.svg" alt=""></a>
7+
<a href="https://github.com/wniemiec-io-java/text-file-manager/actions/workflows/macos.yml"><img src="https://github.com/wniemiec-io-java/text-file-manager/actions/workflows/macos.yml/badge.svg" alt=""></a>
8+
<a href="https://github.com/wniemiec-io-java/text-file-manager/actions/workflows/ubuntu.yml"><img src="https://github.com/wniemiec-io-java/text-file-manager/actions/workflows/ubuntu.yml/badge.svg" alt=""></a>
9+
<a href="https://codecov.io/gh/wniemiec-io-java/text-file-manager"><img src="https://codecov.io/gh/wniemiec-io-java/text-file-manager/branch/master/graph/badge.svg?token=R2SFS4SP86" alt="Coverage status"></a>
10+
<a href="http://java.oracle.com"><img src="https://img.shields.io/badge/java-11+-D0008F.svg" alt="Java compatibility"></a>
11+
<a href="https://mvnrepository.com/artifact/io.github.wniemiec-io-java/text-file-manager"><img src="https://img.shields.io/maven-central/v/io.github.wniemiec-io-java/text-file-manager" alt="Maven Central release"></a>
12+
<a href="https://github.com/wniemiec-io-java/text-file-manager/blob/master/LICENSE"><img src="https://img.shields.io/github/license/wniemiec-io-java/text-file-manager" alt="License"></a>
13+
</p>
14+
<hr />
15+
16+
## ❇ Introduction
17+
Text File Manager performs operations with text files simply and easily.
18+
19+
## ❓ How to use
20+
1. Add one of the options below to the pom.xml file:
21+
22+
#### Using Maven Central (recomended):
23+
```
24+
<dependency>
25+
<groupId>io.github.wniemiec-io-java</groupId>
26+
<artifactId>text-file-manager</artifactId>
27+
<version>LATEST</version>
28+
</dependency>
29+
```
30+
31+
#### Using GitHub Packages:
32+
```
33+
<dependency>
34+
<groupId>wniemiec.io.java</groupId>
35+
<artifactId>text-file-manager</artifactId>
36+
<version>LATEST</version>
37+
</dependency>
38+
```
39+
40+
2. Run
41+
```
42+
$ mvn install
43+
```
44+
45+
3. Use it
46+
```
47+
[...]
48+
49+
import wniemiec.io.java.TextFileManager;
50+
51+
[...]
52+
53+
List<String> content = List.of("hello", "world!");
54+
Path targetFile = Path.of("example-file.txt");
55+
56+
TextFileManager txtFileManager = new TextFileManager(targetFile, StandardCharsets.ISO_8859_1);
57+
txtFileManager.writeLines(content);
58+
59+
System.out.println( txtFileManager.readLines() );
60+
61+
[...]
62+
```
63+
64+
65+
## 📖 Documentation
66+
| Property |Parameter type|Return type|Description|Default parameter value|
67+
|----------------|-------------------------------|-----|------------------------|--------|
68+
|readLines |`void`|`List<String>`|Gets all lines from a file and puts them in a list| - |
69+
|writeLines |`lines: List<String>`|`void`|Writes all items in a string list to a file| - |
70+
71+
## 🚩 Changelog
72+
Details about each version are documented in the [releases section](https://github.com/williamniemiec/wniemiec-io-java/text-file-manager/releases).
73+
74+
## 🤝 Contribute!
75+
See the documentation on how you can contribute to the project [here](https://github.com/wniemiec-io-java/text-file-manager/blob/master/CONTRIBUTING.md).
76+
77+
## 📁 Files
78+
79+
### /
80+
| Name |Type|Description|
81+
|----------------|-------------------------------|-----------------------------|
82+
|dist |`Directory`|Released versions|
83+
|docs |`Directory`|Documentation files|
84+
|src |`Directory`| Source files|

‎dist/1.x/text-file-manager-1.0.0.jar

5.73 KB
Binary file not shown.

0 commit comments

Comments
 (0)