-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
1dc36d5
commit 9f982a5
Showing
18 changed files
with
889 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
--- | ||
name: Bug Report | ||
about: Create a report to help us improve | ||
title: '' | ||
labels: Bug | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Describe the bug** | ||
A clear and concise description of what the bug is. | ||
|
||
**To Reproduce** | ||
Steps to reproduce the behavior: | ||
1. Go to '...' | ||
2. Run '....' | ||
3. See error | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
**Package (please complete the following information):** | ||
- Source: [e.g. NPM, GitHub] | ||
- Version: [e.g. 1.0.0, main] | ||
|
||
**Additional context** | ||
Add any other context about the problem here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: Feature Request | ||
assignees: '' | ||
|
||
--- | ||
|
||
**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 [...] | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of what you want to happen. | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
--- | ||
name: Question | ||
about: Ask a question unrelated to a bug or feature | ||
title: '' | ||
labels: Help Wanted, Undecided | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Question** | ||
Ask a clear and concise question. | ||
|
||
**Package (please complete the following information):** | ||
- Source: [e.g. NPM] | ||
- Version [e.g. 1.0.0] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node | ||
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs | ||
|
||
name: "Node.js" | ||
|
||
on: | ||
pull_request: | ||
branches: [ "main", main* ] | ||
push: | ||
branches: [ "main" ] | ||
|
||
permissions: | ||
contents: read | ||
|
||
jobs: | ||
test: | ||
name: Test | ||
runs-on: ubuntu-latest | ||
strategy: | ||
matrix: | ||
node-version: [18.x, 20.x] | ||
# See supported Node.js release schedule at https://nodejs.org/en/about/releases/ | ||
steps: | ||
- name: Checkout The Branch | ||
uses: actions/checkout@v3 | ||
- name: Use Node.js v${{ matrix.node-version }} | ||
uses: actions/setup-node@v3 | ||
with: | ||
node-version: ${{ matrix.node-version }} | ||
cache: 'npm' | ||
- name: Install Dependencies | ||
run: npm ci | ||
- name: Build Package | ||
run: npm run build | ||
- name: Run Tests | ||
run: npm run test |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,108 @@ | ||
.DS_Store | ||
|
||
/tst-run/ | ||
|
||
# Logs | ||
logs | ||
*.log | ||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
lerna-debug.log* | ||
|
||
# Diagnostic reports (https://nodejs.org/api/report.html) | ||
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json | ||
|
||
# Runtime data | ||
pids | ||
*.pid | ||
*.seed | ||
*.pid.lock | ||
|
||
# Directory for instrumented libs generated by jscoverage/JSCover | ||
lib-cov | ||
|
||
# Coverage directory used by tools like istanbul | ||
coverage | ||
*.lcov | ||
|
||
# nyc test coverage | ||
.nyc_output | ||
|
||
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) | ||
.grunt | ||
|
||
# Bower dependency directory (https://bower.io/) | ||
bower_components | ||
|
||
# node-waf configuration | ||
.lock-wscript | ||
|
||
# Compiled binary addons (https://nodejs.org/api/addons.html) | ||
build/Release | ||
|
||
# Dependency directories | ||
node_modules/ | ||
jspm_packages/ | ||
|
||
# TypeScript v1 declaration files | ||
typings/ | ||
|
||
# TypeScript cache | ||
*.tsbuildinfo | ||
|
||
# Optional npm cache directory | ||
.npm | ||
|
||
# Optional eslint cache | ||
.eslintcache | ||
|
||
# Microbundle cache | ||
.rpt2_cache/ | ||
.rts2_cache_cjs/ | ||
.rts2_cache_es/ | ||
.rts2_cache_umd/ | ||
|
||
# Optional REPL history | ||
.node_repl_history | ||
|
||
# Output of 'npm pack' | ||
*.tgz | ||
|
||
# Yarn Integrity file | ||
.yarn-integrity | ||
|
||
# dotenv environment variables file | ||
.env | ||
.env.test | ||
|
||
# parcel-bundler cache (https://parceljs.org/) | ||
.cache | ||
|
||
# Next.js build output | ||
.next | ||
|
||
# Nuxt.js build / generate output | ||
.nuxt | ||
dist | ||
|
||
# Gatsby files | ||
.cache/ | ||
# Comment in the public line in if your project uses Gatsby and *not* Next.js | ||
# https://nextjs.org/blog/next-9-1#public-directory-support | ||
# public | ||
|
||
# vuepress build output | ||
.vuepress/dist | ||
|
||
# Serverless directories | ||
.serverless/ | ||
|
||
# FuseBox cache | ||
.fusebox/ | ||
|
||
# DynamoDB Local files | ||
.dynamodb/ | ||
|
||
# TernJS port file | ||
.tern-port |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
{ | ||
"editor.detectIndentation": false, | ||
"editor.formatOnSave": true, | ||
"editor.insertSpaces": true, | ||
"editor.rulers": [ | ||
79, | ||
80, | ||
119, | ||
120 | ||
], | ||
"files.encoding": "utf8", | ||
"files.eol": "\n", | ||
"files.insertFinalNewline": true, | ||
"files.trimTrailingWhitespace": true, | ||
"javascript.format.insertSpaceAfterCommaDelimiter": true, | ||
"javascript.format.insertSpaceAfterConstructor": true, | ||
"javascript.format.insertSpaceAfterFunctionKeywordForAnonymousFunctions": true, | ||
"javascript.format.insertSpaceAfterKeywordsInControlFlowStatements": true, | ||
"javascript.format.insertSpaceAfterOpeningAndBeforeClosingNonemptyBrackets": false, | ||
"javascript.format.insertSpaceAfterOpeningAndBeforeClosingNonemptyParenthesis": true, | ||
"javascript.format.insertSpaceAfterSemicolonInForStatements": true, | ||
"javascript.format.insertSpaceBeforeAndAfterBinaryOperators": true, | ||
"javascript.format.insertSpaceBeforeFunctionParenthesis": true, | ||
"javascript.format.placeOpenBraceOnNewLineForControlBlocks": false, | ||
"javascript.format.placeOpenBraceOnNewLineForFunctions": false, | ||
"typescript.format.insertSpaceAfterCommaDelimiter": true, | ||
"typescript.format.insertSpaceAfterConstructor": true, | ||
"typescript.format.insertSpaceAfterFunctionKeywordForAnonymousFunctions": true, | ||
"typescript.format.insertSpaceAfterKeywordsInControlFlowStatements": true, | ||
"typescript.format.insertSpaceAfterOpeningAndBeforeClosingNonemptyBrackets": false, | ||
"typescript.format.insertSpaceAfterOpeningAndBeforeClosingNonemptyParenthesis": true, | ||
"typescript.format.insertSpaceAfterSemicolonInForStatements": true, | ||
"typescript.format.insertSpaceBeforeAndAfterBinaryOperators": true, | ||
"typescript.format.insertSpaceBeforeFunctionParenthesis": true, | ||
"typescript.format.placeOpenBraceOnNewLineForControlBlocks": false, | ||
"typescript.format.placeOpenBraceOnNewLineForFunctions": false, | ||
"typescript.tsdk": "./node_modules/typescript/lib" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
TypeScript Library of the Mastodon CLI is authored by: | ||
* Sophie Bremer |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
Changelog | ||
========= | ||
|
||
|
||
|
||
v0.0.1 | ||
------ | ||
|
||
* Initial release |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
# Instructions for Logging Issues # | ||
|
||
|
||
## 1. Do you have a question? ## | ||
|
||
The issue tracker is for **issues**, in other words, bugs and suggestions. | ||
If you have a *question*, please use | ||
* [Mastodon](https://mastodon.social/tags/MastodonAPI), | ||
* [Stack Overflow](https://stackoverflow.com/questions/tagged/mastodon), | ||
* your favorite search engine, | ||
* or other resources. | ||
|
||
|
||
## 2. Did you find a bug? ## | ||
|
||
When logging a bug, please be sure to include the following: | ||
* What version of TSL-Mastodon-CLI you're using (run `npm list tsl-mastodon-cli`) | ||
* What version of TypeScript you're using (run `tsc --v`) | ||
* If at all possible, an *isolated* way to reproduce the behavior | ||
* The behavior you expect to see, and the actual behavior | ||
|
||
|
||
## 3. Do you have a suggestion? ## | ||
|
||
We also accept suggestions in the issue tracker. | ||
|
||
In general, things we find useful when reviewing suggestions are: | ||
* A description of the problem you're trying to solve | ||
* An overview of the suggested solution | ||
* Examples of how the suggestion would work in various places | ||
* Code examples showing e.g. "this would be an error, this wouldn't" | ||
* Code examples showing the generated JavaScript (if applicable) | ||
* If relevant, precedent in other languages can be useful for establishing context and expected behavior | ||
|
||
|
||
|
||
# Instructions for Contributing Code # | ||
|
||
|
||
## Code of Conduct ## | ||
|
||
This project has adopted a [Code of Conduct](https://typescriptlibs.org/CONDUCT.pdf). | ||
Please contact <conduct@typescriptlibs.org> with any questions or comments. | ||
|
||
|
||
## Contributing bug fixes ## | ||
|
||
TypeScriptLibs is currently accepting contributions in the form of bug fixes. | ||
A bug must have an issue tracking it in the issue tracker that has been approved (set to a Milestone) by the TypeScriptLibs team. | ||
Your pull request should include a link to the bug that you are fixing. | ||
If you've submitted a PR (pull request) for a bug, please post a comment in the bug to avoid duplication of effort. | ||
|
||
|
||
## Contributing features ## | ||
|
||
Features (things that add new or improved functionality) may be accepted, but will need to first be approved (set to a Milestone by a TypeScriptLibs coordinator with the message "Approved") in the suggestion issue. | ||
|
||
Design changes will not be accepted at this time. | ||
If you have a design change proposal, please log a suggestion issue. | ||
|
||
|
||
## Housekeeping ## | ||
|
||
Your pull request should: | ||
|
||
* Include a description of what your change intends to do | ||
* Be a child commit of a reasonably recent commit in the **main** branch | ||
* Requests need not be a single commit, but should be a linear sequence of commits (i.e. no merge commits in your PR) | ||
* It is desirable, but not necessary, for the tests to pass at each commit | ||
* Have clear commit messages | ||
* e.g. "Refactor feature", "Fix issue", "Add tests for issue" | ||
* Include adequate tests | ||
* At least one test should fail in the absence of your non-test code changes. If your PR does not match this criteria, please specify why | ||
* Tests should include reasonable permutations of the target fix/change | ||
* Include baseline changes with your change | ||
* All changed code must have 100% code coverage | ||
* To avoid line ending issues, set `autocrlf = input` and `whitespace = cr-at-eol` in your git configuration |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
Security Policy | ||
=============== | ||
|
||
|
||
|
||
Supported Versions | ||
------------------ | ||
|
||
The following versions of tsl-mastodon-cli are currently being supported with security updates. | ||
|
||
| Version | Supported | | ||
| ------- | --------- | | ||
| 0.1.0 | yes | | ||
| < 0.1.0 | no | | ||
|
||
|
||
|
||
Reporting a Vulnerability | ||
------------------------- | ||
|
||
**Please do not report security vulnerabilities through public GitHub issues.** | ||
|
||
Send a detailed description of the security issue to typescriptlibs.org under the `security@` handle. | ||
Please understand that only security issues regarding the library can be addressed. | ||
|
||
If you found a security issue in Mastodon, please contact them instead. | ||
How to report security issues to Mastodon is described at [github.com/mastodon](https://github.com/mastodon/mastodon/security/policy). | ||
|
||
If you found a security issue in TSL-Mastodo-API, please contact them instead. | ||
How to report security issues to TSL-Mastodo-API is described at [github.com/typescriptlibs/tsl-mastodon-api](https://github.com/typescriptlibs/tsl-mastodon-api/security/policy). | ||
|
||
When typescriptlibs.org receives a secruity report, the review process will take about four weeks. | ||
We might ask for more details or assistence in understanding the security impact. | ||
In case of a valid report, a security advisory will be created and security update released. |
Oops, something went wrong.