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

fix eslint and prettier errors #216

Merged
merged 1 commit into from
Feb 25, 2022
Merged

Conversation

midouest
Copy link
Contributor

@midouest midouest commented Feb 5, 2022

I'm planning on tackling some of the "good first issue" issues in this repo. However, I noticed that I'm getting a lot of lint errors in VSCode, so I decided to run yarn lint --fix first. I did have to manually fix a few spots which I will call out with comments.

Thanks for considering these changes!

@@ -125,7 +127,7 @@ const mapDispatchToProps = dispatch => ({
if (file) {
if (file.includes('/lib/') || file.includes('/data/') || file.includes('/audio/')) {
console.log('files under /lib/, /data/, and /audio/ cannot be run as a script');
return undefined;
return;
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Eslint is expecting consistent return values, so we either need to explicitly return undefined in all code paths, or return void (which should end up being undefined anyway).

const project_version = props.project.get('version');
const project_url = props.project.get('project_url');
const projectVersion = props.project.get('version');
const projectUrl = props.project.get('project_url');
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Renamed snake_case variables to camelCase

@@ -44,6 +44,8 @@
margin-right: 10px;
border: 1px solid transparent;
color: var(--interactive-medium-default);
background: none;
font-family: monospace;
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Changed this element from a div to a button to address lint errors related to accessibility. That affected its appearance so I added these styles which I think brings it back in line with the original appearance.

className={editorOptionClasses(key, val)}
onClick={() => this.updateConfiguration(key, val)}
>
{label}
</div>
</button>
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Change to a button to assist users using keyboards or screen readers.

@@ -51,12 +51,12 @@ class Editor extends Component {

keyService.bindings.forEach(({ keystroke }) => {
const cpIndex = keymap.findIndex(x => x.keys === keystroke.vimKey);
if (~cpIndex) {
if (cpIndex !== -1) {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not 100% certain on the intent here, but it seems like this has the same behavior as ~cpIndex. ~cpIndex will be truthy unless cpIndex is -1.

@@ -222,6 +222,23 @@ export const bufferRead = resource => dispatch => {
});
};

export const directoryRead = resource => dispatch => {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Moved this definition up to fix a use-before-definition error.

}
}

export const commandService = new CommandService();
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Moved this definition up to fix a use-before-definition error.

successArr = successArr.sort(orderResultsByProjectName).filter(response => response.successResult.updated);
success = [...successArr]
.sort(orderResultsByProjectName)
.filter(response => response.successResult.updated);
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fix an error caused by reassigning a function argument. I also created a shallow copy of the original argument because sort mutates the array in place.

};

export const orderResultsByProjectName = (a, b) => a.name < b.name ? -1 : a.name > b.name ? 1 : 0;
export const orderResultsByProjectName = (a, b) => a.name.localeCompare(b.name);
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fix an error due to nested ternary-if statements. I replaced the logic with String.prototype.localeCompare which has the same behavior.

@ngwese
Copy link
Member

ngwese commented Feb 5, 2022

Thanks for the PR! Fixing the lint and formatting stuff is long overdue. I’m trying to remember why we backed away from it in the early days.

I’ll try to review today or tomorrow in more detail!

Copy link
Member

@ngwese ngwese left a comment

Choose a reason for hiding this comment

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

thank you for taking the time to fix all this. i'm honestly a bit embarrassed by all the inconsistency in the code.

@ngwese ngwese merged commit ffa451b into monome:main Feb 25, 2022
@ngwese
Copy link
Member

ngwese commented Feb 25, 2022

so so sorry for the delay in reviewing and merging. time has been in short supply and i prioritized a bunch of kernel work to support the 2022 shield hardware.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants