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

Simplifying Dev Process #470

Merged
merged 1 commit into from
Apr 3, 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
3 changes: 0 additions & 3 deletions .commitlintrc

This file was deleted.

4 changes: 0 additions & 4 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1,9 +1,5 @@
* text=auto
**/*.html linguist-documentation
js/velocity.min.js linguist-vendored
js/jquery.easing.1.4.js linguist-vendored
js/jquery.timeago.min.js linguist-vendored


css/ghpages-materialize.css merge=ours
.gitignore merge=ours
Expand Down
49 changes: 0 additions & 49 deletions .github/workflows/docs.yml

This file was deleted.

11 changes: 0 additions & 11 deletions .github/workflows/lint-commits.yml

This file was deleted.

1 change: 0 additions & 1 deletion .husky/.gitignore

This file was deleted.

5 changes: 0 additions & 5 deletions .husky/commit-msg

This file was deleted.

5 changes: 0 additions & 5 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@
js/anime.min.js
js/cash.js
js/waves.js
js/jquery.timeago.min.js
node_modules/
package.json
package.json.lock
bin/
dist/
extras/
css/
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ patches and features.
Before you now get lost in the repository, here are a few starting points for you to check out. You might find that others have had similar questions or that your question rather belongs in one place than another.

* Chat: https://gitter.im/materializecss/materialize
* Website: https://materializecss.github.io/materialize
* Website: https://materializeweb.com
* Github discussions: https://github.com/materializecss/materialize/discussions

## Using the issue tracker
Expand Down Expand Up @@ -169,7 +169,7 @@ If you want to help us translate the documentation into other languages, you can

After `npm install`, you can run `npm test` and it will run the tests. If you get any errors and have not made any changes, it means you have not installed the proper dependencies.

Materialize uses Jasmine as the testing framework. We also include a jQuery library which allows you to write tests using jQuery syntax.
Materialize uses Jasmine as the testing framework.

### Starting Out

Expand Down Expand Up @@ -199,7 +199,7 @@ expect(toast.length).toBe(0, 'because toast should be removed by now');
```
When this expect statement fails it will list the reason as “because toast should be removed by now”.

Because our components are very front end heavy, familiarize yourself with jQuery ways of interacting with the dom and our components. You can use methods like [trigger](http://api.jquery.com/trigger/), to simulate certain events like the user clicking a button.
Because our components are very front end heavy, familiarize yourself with jQuery ways of interacting with the dom and our components. Maybe use ```dispatch();``` to simulate certain events like the user clicking a button.

We also understand that testing CSS properties is pretty tough so you’ll have to be creative when writing good tests that ensure the styling is still working. Try and cover as many cases as you can but don’t worry if there are some edge cases. You can add comments describing some problematic edge cases in TODOs so we know about them.

Expand Down
42 changes: 10 additions & 32 deletions Gruntfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,25 @@ const path = require('path');
const sass = require('sass');
const webpackConfig = require('./webpack.config.js');

module.exports = function(grunt) {
module.exports = function (grunt) {
// configure the tasks
const config = {
jasmine: {
components: {
src: ['bin/materialize.js'],
options: {
vendor: ['node_modules/jquery/dist/jquery.min.js'],
styles: 'bin/materialize.css',
specs: 'tests/spec/**/*Spec.js',
helpers: 'tests/spec/helper.js',
keepRunner: true,
version: '3.8.0',
page: {
viewportSize: {
width: 1400,
height: 735
}
},
sandboxArgs: {
args: ['--headless', '--no-sandbox']
args: ['--no-sandbox']
}
}
}
Expand Down Expand Up @@ -80,17 +78,7 @@ module.exports = function(grunt) {

postcss: {
options: {
processors: [
require('autoprefixer')({
browsers: [
'last 2 versions',
'Chrome >= 30',
'Firefox >= 30',
'ie >= 10',
'Safari >= 8'
]
})
]
processors: [require('autoprefixer')()]
},
expanded: {
src: 'dist/css/materialize.css'
Expand Down Expand Up @@ -282,7 +270,7 @@ module.exports = function(grunt) {
banner:
'/*!\n * Materialize v' +
grunt.option('newver') +
' (https://materializecss.github.io/materialize)\n * Copyright 2014-' +
' (https://materializeweb.com)\n * Copyright 2014-' +
new Date().getFullYear() +
' Materialize\n * MIT License (https://raw.githubusercontent.com/materializecss/materialize/master/LICENSE)\n */',
linebreak: true
Expand Down Expand Up @@ -315,8 +303,8 @@ module.exports = function(grunt) {
options: {
port: 9001,
protocol: 'http',
middleware: function(connect, options, middlewares) {
middlewares.unshift(function(req, res, next) {
middleware: function (connect, options, middlewares) {
middlewares.unshift(function (req, res, next) {
res.setHeader('Access-Control-Allow-Origin', '*');
res.setHeader('Access-Control-Allow-Credentials', true);
res.setHeader(
Expand Down Expand Up @@ -350,6 +338,10 @@ module.exports = function(grunt) {
grunt.loadNpmTasks('grunt-contrib-connect');

// define tasks
grunt.registerTask('monitor', ['concurrent:monitor']); // DEV
grunt.registerTask('sass_compile', ['sass:gh', 'sass:bin', 'postcss:bin']);
grunt.registerTask('jas_test', ['connect', 'jasmine']);
grunt.registerTask('test', ['webpack:dev', 'sass_compile', 'jas_test']);
grunt.registerTask('release', [
'replace:version', // before webpack
'sass:expanded',
Expand All @@ -368,18 +360,4 @@ module.exports = function(grunt) {
'rename:rename_src',
'rename:rename_compiled'
]);

grunt.registerTask('sass_compile', ['sass:gh', 'sass:bin', 'postcss:bin']);
grunt.registerTask('monitor', ['concurrent:monitor']); // DEV
grunt.registerTask('test', ['webpack:dev', 'sass_compile', 'connect', 'jasmine']);
grunt.registerTask('jas_test', ['connect', 'jasmine']);

grunt.registerTask('test_repeat', function() {
const tasks = ['connect'];
const n = 30;
for (let i = 0; i < n; i++) {
tasks.push('jasmine');
}
grunt.task.run(tasks);
});
};
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2014-2023 Materialize
Copyright (c) 2014-2024 Materialize

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
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<a href="https://materializecss.github.io/materialize/">
<a href="https://materializeweb.com">
<img src="https://materializeweb.com/images/materialize.svg" width="200">
</a>
</p>
Expand All @@ -9,7 +9,7 @@
<p align="center">
Materialize, a CSS Framework based on Material Design.
<br>
<a href="https://materializecss.github.io/materialize/"><strong>-- Browse the docs --</strong></a>
<a href="https://materializeweb.com"><strong>-- Browse the docs --</strong></a>
<br>
<br>
<a href="https://github.com/materializecss/materialize/actions/">
Expand All @@ -30,15 +30,15 @@
</p>

## Quickstart
Read the [getting started guide](https://materializecss.github.io/materialize/getting-started.html) for more information on how to use materialize.
Read the [getting started guide](https://materializeweb.com/getting-started.html) for more information on how to use materialize.

- [Download the latest release](https://github.com/materializecss/materialize/releases/latest) of materialize directly from GitHub. ([Beta](https://github.com/materializecss/materialize/releases/))
- Clone the repo: `git clone https://github.com/materializecss/materialize.git`
- Include the files via [jsDelivr](https://www.jsdelivr.com/package/npm/@materializecss/materialize).
- Install with [npm](https://www.npmjs.com): `npm install @materializecss/materialize` (Beta: `npm install @materializecss/materialize@next`)

## Documentation
The documentation can be found at <https://materializecss.github.io/materialize>. To run the documentation locally on your machine, you need [Node.js](https://nodejs.org/en/) installed on your computer.
The documentation can be found at <https://materializeweb.com>. To run the documentation locally on your machine, you need [Node.js](https://nodejs.org/en/) installed on your computer.

### Running documentation locally
Run these commands to set up the documentation:
Expand Down
41 changes: 0 additions & 41 deletions bower.json

This file was deleted.

4 changes: 0 additions & 4 deletions commitlint.config.js

This file was deleted.

Loading
Loading