Skip to content

Commit

Permalink
fix: fix badges and links to guidelines
Browse files Browse the repository at this point in the history
The bug is fixed by updating the dependency of gobstones-scripts to 0.8.3 and updating configuration
files.
  • Loading branch information
alanrodas committed Apr 11, 2024
1 parent 2a19a81 commit 7e35c84
Show file tree
Hide file tree
Showing 12 changed files with 89 additions and 19 deletions.
2 changes: 1 addition & 1 deletion .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ module.exports = {
}
],

'import/no-unresolved': 'error',
'import/no-unresolved': ['error', { ignore: ['^@?[\\w\\d-_]+/?[\\w\\d-_]+/[\\w\\d-_]+$'] }],
'import/order': [
'error',
{
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Bug report
about: Create a report to help us improve
---

Before opening a new issue, please take a moment to review our [**guidelines**](https://github.com/gobstones/gobstones-guidelines) to make the contribution process easy and effective for everyone involved.
Before opening a new issue, please take a moment to review our [**guidelines**](https://gobstones.github.io/gobstones-guidelines/) to make the contribution process easy and effective for everyone involved.

## Description

Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ name: Feature request
about: Suggest an idea for this project
---

Before opening a new feature request, please take a moment to review our [**guidelines**](https://github.com/gobstones/gobstones-guidelines) to make the contribution process easy and effective for everyone involved.
Before opening a new feature request, please take a moment to review our [**guidelines**](https://gobstones.github.io/gobstones-guidelines/) to make the contribution process easy and effective for everyone involved.

More specifically, see our **roadmap** to be aware if the feature you are considering is already planned. If you still considere the feature is worth requesting, please complete the following:
More specifically, see our **roadmap** to be aware if the feature you are considering is already planned. If you still consider the feature is worth requesting, please complete the following:

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
Expand Down
6 changes: 3 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Gobstones

Thank you for contributing! Please take a moment to review our
[**guidelines**](https://github.com/gobstones/gobstones-guidelines) to make the
[**guidelines**](https://gobstones.github.io/gobstones-guidelines/) to make the
process easy and effective for everyone involved.

**Please open an issue** before embarking on any significant pull request,
Expand All @@ -11,7 +11,7 @@ merged into the project.

Before opening a pull request, please ensure:

- [ ] You have followed our [**guidelines**](https://github.com/gobstones/gobstones-guidelines)
- [ ] You have followed our [**guidelines**](https://gobstones.github.io/gobstones-guidelines/)
- [ ] Double-check your branch is based on `main` and targets `main`
- [ ] Pull request has tests (we are going for 100% coverage!)
- [ ] Code is well-commented, linted and follows project conventions
Expand All @@ -25,4 +25,4 @@ as possible.

**IMPORTANT**: By submitting a patch, you agree to allow the project
owners to license your work under the terms of our
[License](https://github.com/gobstones/gobstones-guidelines/blob/main/LICENSE).
[License](https://gobstones.github.io/gobstones-guidelines/LICENSE/).
8 changes: 4 additions & 4 deletions .husky/pre-commit
Original file line number Diff line number Diff line change
Expand Up @@ -44,13 +44,13 @@ npx --no -- gobstones-scripts run prettify --silent ;
echo "\nRun changelog\n";
npx --no gobstones-scripts run changelog --silent ;

# Add all generated files
echo "\nAdd generated files to commit\n";
git add --all;

# Run license
echo "\nAdd license text to code files\n";
npx --no gobstones-scripts run license --silent ;

# Add all generated files
echo "\nAdd generated files to commit\n";
git add --all;

# Exit
exit 0;
1 change: 0 additions & 1 deletion .vscode/extensions.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
"recommendations": [
"streetsidesoftware.code-spell-checker",
"editorconfig.editorconfig",
"esbenp.prettier-vscode",
"dbaeumer.vscode-eslint",
"orta.vscode-jest",
"christian-kohler.path-intellisense",
Expand Down
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
## <small>0.5.1 (2024-04-11)</small>

* refactor(docs): remove docs folder ([2a19a81](https://github.com/gobstones/gobstones-core/commit/2a19a81))



## 0.5.0 (2024-04-06)

- refactor: rename folders to match guidelines ([be8838f](https://github.com/gobstones/gobstones-core/commit/be8838f))
Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Contibution Guidelines

Please, before contributing to this project, take a moment to read our [Contributions Guidelines](https://github.com/gobstones/gobstones-guidelines).
Please, before contributing to this project, take a moment to read our [Contributions Guidelines](https://gobstones.github.io/gobstones-guidelines/).

Also, be sure to understand that by contributing you agree to allow
the project owners to license your work under the terms of our
[License](https://github.com/gobstones/gobstones-guidelines/blob/main/LICENSE).
[License](https://gobstones.github.io/gobstones-guidelines/LICENSE/).
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

A set of utility types, interfaces and classes that are used through all the Gobstones Platform repositories.

[![Licence](https://img.shields.io/github/license/gobstones/gobstones-core?style=plastic&label=License&logo=open-source-initiative&logoColor=white&color=olivegreen)](https://github.com/gobstones/gobstones-core/blob/main/LICENSE) [![Version](https://img.shields.io/github/package-json/v/gobstones/gobstones-core?style=plastic&label=Version&logo=git-lfs&logoColor=white&color=crimson)](https://www.npmjs.com/package/@gobstones/gobstones-core) [![API Docs](https://img.shields.io/github/package-json/homepage/gobstones/gobstones-core?color=blue&label=API%20Docs&logo=gitbook&logoColor=white&style=plastic)](https://gobstones.github.io/gobstones-core)
[![Licence](https://img.shields.io/badge/AGPL--3.0_with_additional_terms-olivegreen?style=plastic&label=License&logo=open-source-initiative&logoColor=white&color=olivegreen)](https://github.com/gobstones/gobstones-core/blob/main/LICENSE) [![Version](https://img.shields.io/github/package-json/v/gobstones/gobstones-core?style=plastic&label=Version&logo=git-lfs&logoColor=white&color=crimson)](https://www.npmjs.com/package/@gobstones/gobstones-core)

[![API Docs](https://img.shields.io/github/package-json/homepage/gobstones/gobstones-core?color=blue&label=API%20Docs&logo=gitbook&logoColor=white&style=plastic)](https://gobstones.github.io/gobstones-core)

![GitHub Workflow Tests](https://img.shields.io/github/actions/workflow/status/gobstones/gobstones-core/on-commit-test.yml?style=plastic&label=Tests&logo=github-actions&logoColor=white) ![GitHub Workflow Build](https://img.shields.io/github/actions/workflow/status/gobstones/gobstones-core/on-commit-build.yml?style=plastic&label=Build&logo=github-actions&logoColor=white)

Expand Down
6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@gobstones/gobstones-core",
"version": "0.5.0",
"version": "0.5.1",
"description": "A set of utility types, interfaces and classes that are used through all the Gobstones Platform repositories.",
"repository": "https://github.com/gobstones/gobstones-core",
"homepage": "https://gobstones.github.io/gobstones-core",
Expand Down Expand Up @@ -47,15 +47,15 @@
},
"config": {
"gobstones-scripts": {
"type": "cliLibrary",
"type": "library",
"manager": "npm"
}
},
"dependencies": {
"commander": "^11.1.0"
},
"devDependencies": {
"@gobstones/gobstones-scripts": "^0.8.2",
"@gobstones/gobstones-scripts": "^0.8.3",
"husky": "^8.0.2"
}
}
64 changes: 64 additions & 0 deletions rollup.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
/* eslint-disable @typescript-eslint/no-var-requires */
const fs = require('fs');

const { config } = require('@gobstones/gobstones-scripts');
const commonjs = require('@rollup/plugin-commonjs');
const nodeResolve = require('@rollup/plugin-node-resolve');
const typescript = require('@rollup/plugin-typescript');

const packageJson = JSON.parse(fs.readFileSync('./package.json').toString());

config.init();
const tsConfigPath = config.projectType.tsConfigJSON.toolingFile;

module.exports = [
{
input: 'src/index.ts',
output: [
{
sourcemap: true,
file: packageJson.exports['.'].import.default,
format: 'esm'
},
{
sourcemap: true,
file: packageJson.exports['.'].require.default,
format: 'cjs'
}
],
preserveSymlinks: true,
plugins: [
typescript({
tsconfig: `${tsConfigPath}`,
declarationDir: './typings'
}),
commonjs()
],
external: [/@gobstones\/.*/]
},
{
input: 'src/cli.ts',
output: [
{
sourcemap: true,
file: packageJson.exports['./cli'].import.default,
format: 'esm'
},
{
sourcemap: true,
file: packageJson.exports['./cli'].require.default,
format: 'cjs'
}
],
preserveSymlinks: true,
plugins: [
nodeResolve({ preferBuiltins: true }),
typescript({
tsconfig: `${tsConfigPath}`,
declarationDir: './typings'
}),
commonjs()
],
external: [/@gobstones\/.*/, 'commander', 'fs']
}
];
1 change: 0 additions & 1 deletion src/types/Subset.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@
* @author Pablo E. --Fidel-- Martínez López <fidel.ml@gmail.com>
*/

/* eslint-disable prettier/prettier */
/** This Utility Type works similar to `Partial`, but it proceeds recursively applying `Partial`
* to all attributes of the type argument `K`, included nested ones.
*
Expand Down

0 comments on commit 7e35c84

Please sign in to comment.