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.

Sign up for GitHub

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

Lint Markdown of the form-validations package #1819

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+40 −31
Open

Lint Markdown of the form-validations package #1819

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
614829a
Style(form-validations): Fix documentation by markdown linter
literat Dec 14, 2024
95aa189
Docs(repo): Typo in release names link
literat Dec 14, 2024
35e2c01
Style(web-react): Fix documentation links for Card and Footer
literat Dec 14, 2024
4ddc20f
Style(codemods): Disable markdown heading capitalization for transforms
literat Dec 14, 2024
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
7 changes: 2 additions & 5 deletions .remarkignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,5 @@ dist
build
.github

# Temporary disabled packages
# we will fix them incrementally
form-validations
# Codemods transforms directory
transforms
# Fix case of the files
MIGRATION-*
2 changes: 1 addition & 1 deletion docs/contribution/release-schedule.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ To get support for a specific version, please refer to the [support Slack channe

## Release Names

To get more information about the release names, please refer to the [Release Namse Decision][release-name-decision].
To get more information about the release names, please refer to the [Release Names Decision][release-names-decision].

## Assets Managed Under This Release Schedule

Expand Down
3 changes: 3 additions & 0 deletions packages/codemods/src/transforms/v2/web-react/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
<!--lint disable heading-capitalization-->
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought this was solved by the lowerCaseWords option

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, there is no configuration for this, yet. However, using Web-React seems not correct to me. The package name is web-react, IMHO. And we should use it like everywhere. Or not?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wouldn't backticks help?

# `web-react` v2 Codemods

But the lower-case "v2" is still there, I know.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@literat, so both v2 and web-react should be in the lowercase config? Or does this not work?

@adamkudrna Nope, till my PR is merged, backticks are ignored, and the content is treated like a generic string

I would consider using our fork of the package until it is merged in upstream.


# Web-React v2 Codemods

This is a collection of codemods for updating Web-React v2 components.
Expand Down
3 changes: 3 additions & 0 deletions packages/codemods/src/transforms/v3/web-react/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
<!--lint disable heading-capitalization-->

# Web-React v3 Codemods

This is a collection of codemods for updating Web-React v3 components.
Expand Down
3 changes: 3 additions & 0 deletions packages/codemods/src/transforms/v4/web-react/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
<!--lint disable heading-capitalization-->

# Web-React v4 Codemods

This is a collection of codemods for updating Web-React v4 components.
Expand Down
32 changes: 18 additions & 14 deletions packages/form-validations/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<!--lint disable no-emphasis-as-heading-->
<!-- @see: https://jira.almacareer.tech/browse/DS-1604 -->
<!--lint ignore heading-capitalization-->

# @lmc-eu/spirit-form-validations

> Form validations for Web and Web-Twig packages of the Spirit Design System.
Expand Down Expand Up @@ -40,19 +44,19 @@ Now create a form:

… and validate it:

```
```javascript
window.onload = () => {
const form = document.getElementById("form1");
const form = document.getElementById('form1');

// create the FormValidations instance
const formValidations = new FormValidations(form);
// create the FormValidations instance
const formValidations = new FormValidations(form);

form.addEventListener('submit', function (event) {
event.preventDefault();
form.addEventListener('submit', function (event) {
event.preventDefault();

// check if the form is valid
const valid = formValidations.validate(); // returns true or false
});
// check if the form is valid
const valid = formValidations.validate(); // returns true or false
});
};
```

Expand Down Expand Up @@ -87,7 +91,7 @@ const defaultConfig = {

- **live** - A boolean value indicating whether FormValidations should validate as you type, default is `true`

## Built-in validators
## Built-in Validators

| Name | Usage | Description |
| --------- | ----------------------------------------------------------------------------------------------------- | ------------------------------- |
Expand All @@ -108,7 +112,7 @@ const defaultConfig = {
FormValidations.addValidator(nameOrElem, handler, errorMessage, priority, halt);
```

### Add a custom validator to a field
### Add a Custom Validator to a Field

```javascript
var formValidations = new FormValidations(document.getElementById('form1'));
Expand All @@ -130,7 +134,7 @@ FormValidations.addElementValidator(
);
```

### Add a global custom validator
### Add a Global Custom Validator

A validator to check if the input value is within a specified range.

Expand All @@ -157,7 +161,7 @@ Now you can assign it to your inputs like this
<input type="text" class="form-control" data-spirit-my-range="10,30" />
```

### Add custom error messages
### Add Custom Error Messages

```html
<input required data-spirit-required-message="My custom message" />
Expand Down Expand Up @@ -218,7 +222,7 @@ _Set the current locale globally_
| `locale` | — | ✓ | The corresponding locale |
| `messages` | — | ✓ | Object containing validator names as keys and error texts as values |

### Custom validators
### Custom Validators

**FormValidations.addElementValidator(elem, fn, message, priority, halt)**

Expand Down
20 changes: 10 additions & 10 deletions packages/web-react/src/components/Card/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,11 +89,11 @@ Card can be displayed with a border and a box shadow on hover.

### API

| Name | Type | Default | Required | Description |
| ------------- | --------------------------------------------------------------------------------- | ---------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `direction` | [[Direction dictionary][dictionary-direction], `horizontal-reversed` \| `object`] | `vertical` | ✕ | Direction of the content inside Card component, use object to set responsive values, e.g. `{ mobile: 'horizontal', tablet: 'vertical', desktop: 'horizontal-reversed' }` |
| `elementType` | `ElementType` | `article` | ✕ | Type of element |
| `isBoxed` | `bool` | `false` | ✕ | Whether the Card have border |
| Name | Type | Default | Required | Description |
| ------------- | ---------------------------------------------------------------------------------- | ---------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `direction` | \[[Direction dictionary][dictionary-direction], `horizontal-reversed` \| `object`] | `vertical` | ✕ | Direction of the content inside Card component, use object to set responsive values, e.g. `{ mobile: 'horizontal', tablet: 'vertical', desktop: 'horizontal-reversed' }` |
| `elementType` | `ElementType` | `article` | ✕ | Type of element |
| `isBoxed` | `bool` | `false` | ✕ | Whether the Card have border |

On top of the API options, the components accept [additional attributes][readme-additional-attributes].
If you need more control over the styling of a component, you can use [style props][readme-style-props]
Expand Down Expand Up @@ -220,11 +220,11 @@ horizontal (and reversed horizontal) Cards. But in all other contexts, the two p

### API

| Name | Type | Default | Required | Description |
| ---------------------- | -------------------------------------------- | ------- | -------- | ------------------------------------------- |
| `hasFilledHeightClass` | `bool` | `false` | ✕ | Whether the image fill the height of a Card |
| `isExpanded` | `bool` | `false` | ✕ | Whether the media has space around |
| `size` | [[Size dictionary][dictionary-size], `auto`] | `auto` | ✕ | Size of the image media |
| Name | Type | Default | Required | Description |
| ---------------------- | --------------------------------------------- | ------- | -------- | ------------------------------------------- |
| `hasFilledHeightClass` | `bool` | `false` | ✕ | Whether the image fill the height of a Card |
| `isExpanded` | `bool` | `false` | ✕ | Whether the media has space around |
| `size` | \[[Size dictionary][dictionary-size], `auto`] | `auto` | ✕ | Size of the image media |

On top of the API options, the components accept [additional attributes][readme-additional-attributes].
If you need more control over the styling of a component, you can use [style props][readme-style-props]
Expand Down
1 change: 0 additions & 1 deletion packages/web-react/src/components/Footer/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -273,6 +273,5 @@ and [escape hatches][readme-escape-hatches].
[readme-additional-attributes]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#additional-attributes
[readme-escape-hatches]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#escape-hatches
[readme-style-props]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#style-props
[readme-style-props]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/README.md#style-props
[select]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/Select/README.md
[stack]: https://github.com/lmc-eu/spirit-design-system/blob/main/packages/web-react/src/components/Stack/README.md
Loading