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

add new feature to auto copy function protoype from c file from spec… #14

Closed
wants to merge 3 commits into from

Conversation

be-great
Copy link

@be-great be-great commented Nov 23, 2023

Usage: alxcheck -D <dir_name> -H <header_name>.h

Example: alxcheck -D . -H main.h

This command will check all prototypes in the specified directory for C files. 🕵️‍♂️

Requirements:-

  • Install ctags: sudo apt-get install exuberant-ctags 🛠️
  • Ensure correct function prototypes in C files; for example, the open bracket should be in Betty style on a different line:
    Example: int function(void){} ❌ | int function(void) and the bracket on a new line ✔

Screenshot from 2023-11-23 19-27-38

Screenshot from 2023-11-23 19-28-06

@adobki
Copy link
Contributor

adobki commented Nov 26, 2023

Hello, @be-great. First of all, well done! Month three in ALX SE and already making significant pull requests! Fantastic! Can't wait to see what you'd be doing at month nine, at graduation, and even beyond! 😎

The feature you're proposing is great, but I think it needs some major tweaks to properly align with the project:

  1. Your code hijacks the functionality of the entire program, preventing all the existing code from being accessed once invoked. It needs better integration.
  2. The autoproto function needs to be moved from main.py to align with the project's code/file structure.
  3. Finally, and more as a suggestion, your proposed feature fixes without actually performing any checks, even though the project is aptly named alxcheck. So how about making your code a checker instead, invoked on C files by default, then have the -d/-h switches invoke automatic fixes if the check fails? What do you think?

(DISCLAIMER: I'm just a collaborator, not the project owner or even a major stakeholder.)

@be-great
Copy link
Author

be-great commented Nov 26, 2023

Hello @adobki 🚀

Thank you so much for the positive feedback and constructive suggestions! 🙌 I'm thrilled to contribute to this project and will definitely incorporate your valuable insights. Here's my plan to address your points:

  1. Integration with Existing Code:

    • Your point about integrating the feature more seamlessly is well taken. I'll revisit the design to ensure it doesn't disrupt the existing functionality. 💡
  2. Code/File Structure:

    • Moving the autoproto function to align with the project's structure is a great idea. I'll make the necessary adjustments to keep everything organized. 📁
  3. Checker Functionality:

    • Transforming the feature into a checker with automatic fixes on -d/-h switches is a fantastic suggestion! This aligns perfectly with the project's theme, and I'm excited to implement it. 🛠️

Thank you again for the insight 🌟

@be-great
Copy link
Author

be-great commented Nov 26, 2023

Hello @adobki , @Emmo00 🚀

Thank you for your valuable feedback! 💪 I've made the suggested adjustments to my code and am eager to receive your approval. Please take your time to review, and if there are any further suggestions or changes you'd like, I'm more than happy to address them.

Looking forward to your response! 🌟

@Emmo00
Copy link
Owner

Emmo00 commented Nov 27, 2023

Hey @be-great ... Thanks for your PR.
Sorry I've not been able to review it, I've been busy with some things

Thank you @adobki ... Nice insights

@adobki
Copy link
Contributor

adobki commented Dec 3, 2023

Please take your time to review, and if there are any further suggestions or changes you'd like, I'm more than happy to address them.

Hello, @be-great
Glad I could be of help. Sorry I've been #AWOL. Have a lot of projects I'm working on at the moment.
Wow, well done! I'd do this as soon as I can and let to you know. Thanks.👍

@Emmo00 , don't mention it, bro. I'm always happy to be of help. I see you've been choked-up by all dem projects as well. Less than a month now for us to be done here, and then it's on to the next one! Cheers! 😉 #doHardThings

@be-great
Copy link
Author

what happens ?!

@Emmo00
Copy link
Owner

Emmo00 commented Dec 25, 2023

Hey @be-great

I'm sorry I'm just saying this, but this feature is kinda out of the scope of the project

If you're willing, you can create a new repo and I'll gladly contribute to implement this feature

Don't be mad 🥹, I really appreciate your efforts. Thanks 🙏

@be-great
Copy link
Author

No problem. Thanks for your feedback and time :)

@be-great be-great closed this Dec 25, 2023
@be-great be-great deleted the auoheader branch December 25, 2023 10:44
@Emmo00
Copy link
Owner

Emmo00 commented Dec 25, 2023

Are you moving forward to build it?

@be-great
Copy link
Author

Are you moving forward to build it?

Certainly, I just need some time to organize it. 🙌

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.

3 participants