Skip to content

Commit

Permalink
Basic project structure setup with root files
Browse files Browse the repository at this point in the history
  • Loading branch information
Jeehut committed Mar 7, 2020
1 parent 4d8cb8d commit bf349b2
Show file tree
Hide file tree
Showing 11 changed files with 176 additions and 40 deletions.
32 changes: 32 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).

<details>
<summary>Formatting Rules for Entries</summary>
Each entry should use the following format:

```markdown
- Summary of what was changed in a single line using past tense & followed by two whitespaces.
Issue: [#0](https://github.com/Flinesoft/AnyLint/issues/0) | PR: [#0](https://github.com/Flinesoft/AnyLint/pull/0) | Author: [Cihat Gündüz](https://github.com/Jeehut)
```

Note that at the end of the summary line, you need to add two whitespaces (` `) for correct rendering on GitHub.

If needed, pluralize to `Tasks`, `PRs` or `Authors` and list multiple entries separated by `, `. Also, remove entries not needed in the second line.
</details>

## [Unreleased]
### Added
- None.
### Changed
- None.
### Deprecated
- None.
### Removed
- None.
### Fixed
- None.
### Security
- None.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2020 Flinesoft (alias Cihat Gündüz)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
16 changes: 16 additions & 0 deletions Package.resolved
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"object": {
"pins": [
{
"package": "HandySwift",
"repositoryURL": "https://github.com/Flinesoft/HandySwift.git",
"state": {
"branch": null,
"revision": "083707d9f9da65bd57b756294653ee0fc50d8662",
"version": "3.1.0"
}
}
]
},
"version": 1
}
27 changes: 15 additions & 12 deletions Package.swift
Original file line number Diff line number Diff line change
@@ -1,28 +1,31 @@
// swift-tools-version:5.1
// The swift-tools-version declares the minimum version of Swift required to build this package.

import PackageDescription

let package = Package(
name: "AnyLint",
products: [
// Products define the executables and libraries produced by a package, and make them visible to other packages.
.library(
name: "AnyLint",
targets: ["AnyLint"]),
.library(name: "AnyLint", targets: ["AnyLint"]),
.executable(name: "anylint", targets: ["AnyLintCLI"]),
],
dependencies: [
// Dependencies declare other packages that this package depends on.
// .package(url: /* package url */, from: "1.0.0"),
.package(url: "https://github.com/Flinesoft/HandySwift.git", from: "3.1.0"),
],
targets: [
// Targets are the basic building blocks of a package. A target can define a module or a test suite.
// Targets can depend on other targets in this package, and on products in packages which this package depends on.
.target(
name: "AnyLint",
dependencies: []),
dependencies: ["HandySwift"]
),
.testTarget(
name: "AnyLintTests",
dependencies: ["AnyLint"]),
dependencies: ["AnyLint"]
),
.target(
name: "AnyLintCLI",
dependencies: ["HandySwift"]
),
.testTarget(
name: "AnyLintCLITests",
dependencies: ["AnyLintCLI"]
),
]
)
78 changes: 77 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,79 @@
# AnyLint

A description of this package.
Lint anything by combining the power of Swift & regular expressions.

<p align="center">
<a href="https://app.bitrise.io/app/TODO">
<img src="https://app.bitrise.io/app/TODO/status.svg?token=TODO&branch=main"
alt="Build Status">
</a>
<a href="https://www.codacy.com/gh/Flinesoft/AnyLint">
<img src="https://api.codacy.com/project/badge/Grade/TODO"
alt="Code Quality"/>
</a>
<a href="https://www.codacy.com/gh/Flinesoft/AnyLint">
<img src="https://api.codacy.com/project/badge/Coverage/TODO"
alt="Coverage"/>
</a>
<a href="https://github.com/Flinesoft/AnyLint/releases">
<img src="https://img.shields.io/badge/Version-0.0.0-blue.svg"
alt="Version: 0.0.0">
</a>
<a href="https://github.com/Flinesoft/AnyLint/blob/main/LICENSE">
<img src="https://img.shields.io/badge/License-MIT-lightgrey.svg"
alt="License: MIT">
</a>
<br />
<a href="https://paypal.me/Dschee/5EUR">
<img src="https://img.shields.io/badge/PayPal-Donate-orange.svg"
alt="PayPal: Donate">
</a>
<a href="https://github.com/sponsors/Jeehut">
<img src="https://img.shields.io/badge/GitHub-Become a sponsor-orange.svg"
alt="GitHub: Become a sponsor">
</a>
<a href="https://patreon.com/Jeehut">
<img src="https://img.shields.io/badge/Patreon-Become a patron-orange.svg"
alt="Patreon: Become a patron">
</a>
</p>

<p align="center">
<a href="#installation">Installation</a>
• <a href="#configuration">Configuration</a>
• <a href="#usage">Usage</a>
• <a href="#donation">Donation</a>
• <a href="https://github.com/Flinesoft/AnyLint/issues">Issues</a>
• <a href="#contributing">Contributing</a>
• <a href="#license">License</a>
</p>

# AnyLint

This is the FitnessTracker app project for the Android platform.

## Installation

TODO

## Configuration

TODO

## Usage

TODO

## Donation

AnyLint was brought to you by [Cihat Gündüz](https://github.com/Jeehut) in his free time. If you want to thank me and support the development of this project, please **make a small donation on [PayPal](https://paypal.me/Dschee/5EUR)**. In case you also like my other [open source contributions](https://github.com/Flinesoft) and [articles](https://medium.com/@Jeehut), please consider motivating me by **becoming a sponsor on [GitHub](https://github.com/sponsors/Jeehut)** or a **patron on [Patreon](https://www.patreon.com/Jeehut)**.

Thank you very much for any donation, it really helps out a lot! 💯

## Contributing

Contributions are welcome. Feel free to open an issue on GitHub with your ideas or implement an idea yourself and post a pull request. If you want to contribute code, please try to follow the same syntax and semantic in your **commit messages** (see rationale [here](http://chris.beams.io/posts/git-commit/)). Also, please make sure to add an entry to the `CHANGELOG.md` file which explains your change.

## License

This library is released under the [MIT License](http://opensource.org/licenses/MIT). See LICENSE for details.
6 changes: 3 additions & 3 deletions Sources/AnyLint/AnyLint.swift
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
struct AnyLint {
var text = "Hello, World!"
}
import Foundation

// TODO: [2020-03-07] not yet implemented
3 changes: 3 additions & 0 deletions Sources/AnyLintCLI/AnyLintCLI.swift
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import Foundation

// TODO: [2020-03-07] not yet implemented
8 changes: 8 additions & 0 deletions Tests/AnyLintCLITests/AnyLintCLITests.swift
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import XCTest
@testable import AnyLintCLI

final class AnyLintCLITests: XCTestCase {
func testExample() {
// TODO: [2020-03-07] not yet implemented
}
}
9 changes: 1 addition & 8 deletions Tests/AnyLintTests/AnyLintTests.swift
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,6 @@ import XCTest

final class AnyLintTests: XCTestCase {
func testExample() {
// This is an example of a functional test case.
// Use XCTAssert and related functions to verify your tests produce the correct
// results.
XCTAssertEqual(AnyLint().text, "Hello, World!")
// TODO: [2020-03-07] not yet implemented
}

static var allTests = [
("testExample", testExample),
]
}
9 changes: 0 additions & 9 deletions Tests/AnyLintTests/XCTestManifests.swift

This file was deleted.

7 changes: 0 additions & 7 deletions Tests/LinuxMain.swift

This file was deleted.

0 comments on commit bf349b2

Please sign in to comment.