Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(*): Revamp Docs #47

Merged
merged 131 commits into from
May 30, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
131 commits
Select commit Hold shift + click to select a range
988d7fa
style: Formatted 17 files & changes messageHelper util
Murtatrxx Apr 7, 2022
4f6b5f9
style: Formatted HTML and CSS files
Murtatrxx Apr 12, 2022
74cc1e8
Revert "style: Formatted 17 files & changes messageHelper util"
Murtatrxx Apr 12, 2022
6106a78
style(style.css): Formatted main style file with tabwidth 2
Murtatrxx Apr 12, 2022
85acc73
chore: Added docs maintainer
Murtatrxx Apr 14, 2022
af3be1d
chore: Changed typedoc configration
Murtatrxx Apr 14, 2022
7e9ce62
chore(README.md): Removed coming soon from links
Murtatrxx Apr 14, 2022
cc37927
chore: Updated Prettier formatter tab width
Murtatrxx Apr 14, 2022
0021fff
docs(readme): Improved Readme readability
Murtatrxx Apr 24, 2022
45ebeb5
docs(README): Fixed installation box
Murtatrxx Apr 25, 2022
e9d35ff
style(README.md): Improved readability
Murtatrxx Apr 29, 2022
2bcadb1
chore: Added CONTRIBUTING.md
Murtatrxx Apr 29, 2022
b658150
Merge branch 'revamp-docs' of https://github.com/jacoobes/Sern into r…
Murtatrxx Apr 29, 2022
9c75ddd
docs(README.md): Removed old repo link and it's line
Murtatrxx Apr 29, 2022
b76a894
docs(README): Updated Intents to djs v14
Murtatrxx Apr 29, 2022
9c61ecd
docs: Updated README example to djs v14
Murtatrxx Apr 29, 2022
3a1dbb7
Merge branch 'revamp-docs' of https://github.com/jacoobes/Sern into r…
Murtatrxx Apr 29, 2022
35663b0
docs: Formatted README examples
Murtatrxx Apr 29, 2022
1df38ef
Update README.md
Murtatrxx May 2, 2022
01634b1
docs: Updated organization description
Murtatrxx May 2, 2022
5df1929
docs(README): Rename 'fixed' to 'patched'
Murtatrxx May 4, 2022
83ce42d
chore: Updated LICENSE
Murtatrxx May 10, 2022
3d3c8c2
chore: Updated LICNESE
Murtatrxx May 10, 2022
fa7ddf0
chore: Changed license to MIT
Murtatrxx May 10, 2022
2e65531
Delete LICENSE.md
Murtatrxx May 10, 2022
9745ab0
chore: Recreated LICENSE
Murtatrxx May 10, 2022
b787862
chore: First License boilerplate preview
Murtatrxx May 10, 2022
6164536
style(index.ts): Added a space
Murtatrxx May 10, 2022
ff960db
chore(index.ts): First license boilerplate preview
Murtatrxx May 10, 2022
2e310a1
chore(PRETTIER): Re-updated the tab width
Murtatrxx May 10, 2022
474e781
chore(SECURITY): Updated security.md file
Murtatrxx May 10, 2022
95c26e9
docs(README): Improved readability
Murtatrxx May 13, 2022
0568f3a
fix(README): Fixed typo
Murtatrxx May 15, 2022
54518c1
style: Updated license boilerplate
Murtatrxx May 15, 2022
834b156
style(*): Updated license boilerplate
Murtatrxx May 15, 2022
cb3def0
style: Updated license boilerplate
Murtatrxx May 15, 2022
e2bb0f3
style: Updated license boilerplate
Murtatrxx May 15, 2022
4921e5a
style: Updated license boilerplate
Murtatrxx May 15, 2022
d26a2f6
style: Updated License boilerplate
Murtatrxx May 15, 2022
8b126fe
style: Updated License boilerplate
Murtatrxx May 15, 2022
0dd34f9
docs(README): Added stats
Murtatrxx May 16, 2022
db8fcea
docs(README): Temporarily or permanently removed stats
Murtatrxx May 16, 2022
972928b
refactor: DRY Principles
jacoobes May 17, 2022
97907b7
feat: finished interactionCreate.ts handling? (need test)
jacoobes May 17, 2022
89ef2aa
chore: Updated CONTRIBUTING.md file
Murtatrxx May 17, 2022
6c1130d
chore: Updated credits
Murtatrxx May 17, 2022
ea9554c
chore(NPM): Prepared package.json for release
Murtatrxx May 17, 2022
35de450
revert: Some changes
Murtatrxx May 17, 2022
55bb5eb
revert: Revert back to MIT LICENSE (#50)
Murtatrxx May 17, 2022
e5d9b02
chore: Updated LICENSE boilerplate
Murtatrxx May 17, 2022
effe066
style: Improved comments
Murtatrxx May 17, 2022
3f1f93c
style: Updated comments
Murtatrxx May 17, 2022
b266508
fix: Non-exhaustiveness led to commands not registering readyEvent.ts
jacoobes May 17, 2022
c8c0c84
feat: Add DefinetlyDefined type, more todo statements
jacoobes May 17, 2022
430315a
feat: Aliases optional
jacoobes May 17, 2022
2b81d53
feat: Optional plugins to reduce bloat
jacoobes May 17, 2022
53bc080
feat: better looking typings for modules
jacoobes May 17, 2022
c40b75d
refactor: Simplify sernModule handler signature
jacoobes May 17, 2022
5556b2a
refactor: make ApplicationCommandOptions optional
jacoobes May 17, 2022
f898749
refactor: make description optional
jacoobes May 17, 2022
82f1bad
refactor: Bring CommandType and PluginType to top level
jacoobes May 17, 2022
cf85a5d
fix: Fix return type of sernModule
jacoobes May 17, 2022
464fc05
refactor: Why is that not assignable bruh
jacoobes May 18, 2022
b9b5919
revert: Re-add plugins overload
jacoobes May 18, 2022
32dbaf1
fix(CODE_OF_CONDUCT): Removed unusual dot
Murtatrxx May 18, 2022
45056ba
Update package.json
Murtatrxx May 18, 2022
b12567a
fix: Resolve conflicts
Murtatrxx May 18, 2022
6660aa5
fix: Resolve conflicts
Murtatrxx May 18, 2022
b8cda35
feat: should be able to register other nodejs event emitters
jacoobes May 19, 2022
66b9f51
fix: Standard for of does not resolve promises. Switched to for await
jacoobes May 19, 2022
115d1a4
feat: Adding sern event listeners, overriding and typing methods
jacoobes May 20, 2022
3f64a8a
feat: Edited event names for more conciseness, finished basic event e…
jacoobes May 20, 2022
2d28800
style: Run prettier
jacoobes May 20, 2022
6c144de
fix: didn't run prettier, now i am
jacoobes May 20, 2022
dac665d
fix: linting issue in markup.ts
jacoobes May 20, 2022
571a804
fix: prettier wants lf line ending
jacoobes May 20, 2022
d5bb992
fix: prettier changes again
jacoobes May 20, 2022
7ae5ecf
feat: add .prettierignore and ignore README.md
jacoobes May 20, 2022
fc81bfc
feat: add externallyUsed.ts and support BothCommands again
jacoobes May 22, 2022
a220949
feat: remove comments about prev commit
jacoobes May 22, 2022
2675607
style: change prettier print width and reformat
jacoobes May 22, 2022
77856ce
feat: adding modal and autocomplete support
jacoobes May 22, 2022
d50b801
feat: Finishing up autocomplete, need to test
jacoobes May 22, 2022
ac8a2f4
feat: Making name required in auto cmp interactions
jacoobes May 23, 2022
93942bd
feat: move name and description out of OptionsData[]
jacoobes May 24, 2022
b08eebf
feat: finishing optionData for autocomplete changes, adding class for…
jacoobes May 24, 2022
d63423c
feat: finishing autocomplete!!
jacoobes May 25, 2022
9eef9dd
refactor: Simplifying logic of message filter
jacoobes May 25, 2022
0ae541d
feat: Adding docs to some data structures, moving to default from exp…
jacoobes May 25, 2022
e69dae9
refactor: cleaning up code, removing unuseds
jacoobes May 27, 2022
475b073
feat: adding refactoring for repetitive event plugin processing
jacoobes May 29, 2022
99e2a99
feat: adding better typings, refactoring
jacoobes May 29, 2022
ae59aca
refactor: remove unnecessary nullish short circuit
jacoobes May 29, 2022
cfd68b4
refactor: remove unnecessary nullish short circuit
jacoobes May 29, 2022
f90342d
feat: add docs/ to npmignore
jacoobes May 29, 2022
df9e207
style: Formatted 17 files & changes messageHelper util
Murtatrxx Apr 7, 2022
07c3463
style: Formatted HTML and CSS files
Murtatrxx Apr 12, 2022
4e1ef66
Revert "style: Formatted 17 files & changes messageHelper util"
Murtatrxx Apr 12, 2022
e51e388
style(style.css): Formatted main style file with tabwidth 2
Murtatrxx Apr 12, 2022
0377b08
chore: Added docs maintainer
Murtatrxx Apr 14, 2022
5f1e09e
chore: Changed typedoc configration
Murtatrxx Apr 14, 2022
36dc12e
chore(README.md): Removed coming soon from links
Murtatrxx Apr 14, 2022
030dd47
docs(readme): Improved Readme readability
Murtatrxx Apr 24, 2022
2f10be9
chore: Added CONTRIBUTING.md
Murtatrxx Apr 29, 2022
9ae76b8
docs(README): Fixed installation box
Murtatrxx Apr 25, 2022
6e96658
style(README.md): Improved readability
Murtatrxx Apr 29, 2022
ebb3e89
docs(README.md): Removed old repo link and it's line
Murtatrxx Apr 29, 2022
a723155
docs: Updated README example to djs v14
Murtatrxx Apr 29, 2022
1747298
docs(README): Updated Intents to djs v14
Murtatrxx Apr 29, 2022
4a30a99
docs: Formatted README examples
Murtatrxx Apr 29, 2022
cac03e4
Update README.md
Murtatrxx May 2, 2022
80547b2
chore: Updated LICENSE
Murtatrxx May 10, 2022
cccdd50
chore: Updated LICNESE
Murtatrxx May 10, 2022
355fb39
chore: Changed license to MIT
Murtatrxx May 10, 2022
ff9a73b
Delete LICENSE.md
Murtatrxx May 10, 2022
67a6abe
chore: Recreated LICENSE
Murtatrxx May 10, 2022
6a302c9
chore: First License boilerplate preview
Murtatrxx May 10, 2022
cc1a5b4
style(index.ts): Added a space
Murtatrxx May 10, 2022
492f2b8
chore(index.ts): First license boilerplate preview
Murtatrxx May 10, 2022
8b1ede8
chore(SECURITY): Updated security.md file
Murtatrxx May 10, 2022
85fb1e6
style: Updated license boilerplate
Murtatrxx May 15, 2022
991439c
docs(README): Added stats
Murtatrxx May 16, 2022
2bd5196
chore: Updated CONTRIBUTING.md file
Murtatrxx May 17, 2022
3f597ff
chore: Updated credits
Murtatrxx May 17, 2022
a8aeff3
chore(NPM): Prepared package.json for release
Murtatrxx May 17, 2022
d8ce09f
revert: Some changes
Murtatrxx May 17, 2022
b3be79d
revert: Revert back to MIT LICENSE (#50)
Murtatrxx May 17, 2022
b7872e7
fix(CODE_OF_CONDUCT): Removed unusual dot
Murtatrxx May 18, 2022
dc4ed8d
fix: Resolve conflicts
Murtatrxx May 18, 2022
34c0d99
fix: Resolve conflicts
Murtatrxx May 18, 2022
5ae245f
Merge remote-tracking branch 'origin/revamp-docs' into revamp-docs
jacoobes May 30, 2022
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
src/* @jacoobes
docs/* @Murtatrxx
49 changes: 49 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Contributing

When contributing to this repository, please first discuss the change you wish to make via issue,
email, or any other method with the owners of this repository before making a change.

Please note we have a [code of conduct](https://github.com/sern-handler/handler/blob/main/CODE_OF_CONDUCT.md), please follow it in all your interactions with the project.

## Pull Request Process

1. Ensure any install or build dependencies are removed before the end of the layer when doing a
build.
2. Update the README.md with details of changes to the interface, this includes new environment
variables, exposed ports, useful file locations and container parameters.
3. Increase the version numbers in any examples files and the README.md to the new version that this
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
do not have permission to do that, you may request the second reviewer to merge it for you.

### Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
### Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at our [discord server](https://discord.com/invite/QgnfxWzrcj). All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

### Attribution

This contributing guidelines is adapted from the [Contributor Covenant][homepage], version 1.4,
available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
4 changes: 3 additions & 1 deletion .github/SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,14 @@

## Supported Versions

Project is currently in development and is not yet ready to be used.
Project is currently under heavy development but you can try out our [npm package](https://npmjs.com/package/@sern/handler)

| Version | Supported |
| ------- | ------------------ |
| 0.1.0 @ dev | :white_check_mark: |

* Dev versions might include bugs, use it with your own risk.

## Reporting a Vulnerability

You can report a vulnerability by opening an issue on the [project's GitHub](https://github.com/SernHandler/Sern/issues) repository.
Expand Down
18 changes: 11 additions & 7 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -54,19 +54,20 @@ typings/
# Yarn Integrity file
.yarn-integrity

# dotenv environment variables file
# Typedoc raw output
.typedoc

# Dotenv environment variables file
.env

# parcel-bundler cache (https://parceljs.org/)
# Parcel-bundler cache (https://parceljs.org/)
.cache

# next.js build output
# next.js and nuxt.js build output
.next

# nuxt.js build output
.nuxt

# vuepress build output
# Vuepress build output
.vuepress/dist

# Serverless directories
Expand All @@ -75,8 +76,11 @@ typings/
# FuseBox cache
.fusebox/

# TypeScript build output
dist

# VisualStudio Config file
.vs

.idea
# IntelliJ IDEA Config file
.idea/
3 changes: 2 additions & 1 deletion .npmignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
src/
tsconfig.json
tsconfig.json
docs/
1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
README.md
2 changes: 1 addition & 1 deletion .prettierrc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"semi": true,
"trailingComma": "all",
"singleQuote": true,
"printWidth": 120,
"printWidth": 100,
"tabWidth": 4,
"arrowParens": "avoid"
}
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Code of Conduct
All participants of SernHandler. are expected to abide by our Code of Conduct, both online and during in-person events that are hosted and/or associated with SernHandler.
All participants of SernHandler are expected to abide by our Code of Conduct, both online and during in-person events that are hosted and/or associated with SernHandler.

# The Pledge
In the interest of fostering an open and welcoming environment, we pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
Expand Down
Loading