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

[Feature] Tables #4

Merged
merged 15 commits into from
May 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
130 changes: 130 additions & 0 deletions .github/code-of-conduct.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity
and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
- Focusing on what is best not just for us as individuals, but for the
overall community
- All PR of new components should be own created or from a free source

Examples of unacceptable behavior include:

- The use of sexualized language or imagery, and sexual attention or
advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email
address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting
- Creating components using paid source code like Tailwind UI

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders 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, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
GitHub.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
File renamed without changes.
9 changes: 9 additions & 0 deletions .github/security.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Security Policy

**PLEASE DON'T DISCLOSE SECURITY RELATED ISSUES PUBLICLY!**

## Reporting a Vulnerability

If you discover a security vulnerability within WireUi,
please send an email to our team at **[email protected]**.
All security vulnerabilities will be promptly addressed.
36 changes: 36 additions & 0 deletions .github/workflows/tests.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: WireUi Docs Tests

on:
push:
branches:
- main
pull_request:
branches:
- main

jobs:
build:
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v2

- name: Setup PHP, with composer and extensions
uses: shivammathur/setup-php@v2
with:
php-version: "8.3"
tools: composer:v2
coverage: none

- name: Install Composer Dependencies
run: |
composer install --no-scripts

- name: Code Style Check
run: |
./vendor/bin/pint --test

- name: Run Pest PHP Tests
run: |
./vendor/bin/pest --stop-on-failure
2 changes: 1 addition & 1 deletion LICENSE → license.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2023 WireUi
Copyright (c) WireUi

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
File renamed without changes.
11 changes: 8 additions & 3 deletions src/Commands/ClearCacheCommand.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

use Illuminate\Console\Command;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Str;
use WireUi\Docs\Facades\WireUiDocs;

class ClearCacheCommand extends Command
Expand All @@ -12,15 +13,17 @@ class ClearCacheCommand extends Command

protected $description = 'Clear the Menu Cache';

public function handle(): void
public function handle(): int
{
$this->clearMenuCache();

$sections = WireUiDocs::getSections();
$menu = WireUiDocs::getMenu()->flatten();

$sections->each(fn ($section) => $this->removeCache($section));
$menu->each(fn ($page) => $this->removeCache($page));

$this->info('The cache has been cleared.');

return self::SUCCESS;
}

private function clearMenuCache(): void
Expand All @@ -30,6 +33,8 @@ private function clearMenuCache(): void

private function removeCache(string $page): void
{
$page = Str::slug($page);

Cache::forget("wireui::next::{$page}");

Cache::forget("wireui::previous::{$page}");
Expand Down
1 change: 0 additions & 1 deletion src/Facades/WireUiDocs.php
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
/**
* @method static Collection getMenu()
* @method static bool hasSection(string $section)
* @method static Collection getSections()
* @method static ?array getSection(string $section)
* @method static ?string getDefaultPage(string $section)
* @method static mixed getComponentApi(string $component)
Expand Down
12 changes: 12 additions & 0 deletions src/ServiceProvider.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

use Illuminate\Routing\Router;
use Illuminate\Support;
use Illuminate\Support\Collection;
use Illuminate\Support\Str;
use WireUi\Docs\Middleware\CheckDocs;
use WireUi\Docs\View\Components\Code;

Expand All @@ -15,6 +17,8 @@ public function boot(): void

$this->bootConfig();

$this->bootMacros();

$this->bootCommands();

$this->bootMiddlewares();
Expand All @@ -32,6 +36,14 @@ private function bootViews(): void
$this->loadViewsFrom(__DIR__.'/resources/views', 'docs');
}

private function bootMacros(): void
{
Collection::macro('slugify', function () {
/** @var Collection $this */
return $this->map(fn ($value) => Str::slug($value));
});
}

private function bootCommands(): void
{
if ($this->app->runningInConsole()) {
Expand Down
Loading
Loading